Back to top

SmartZone 100 Public API Reference Guide

Overview

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

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

Common Request Header

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

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

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

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

HTTP Responses

Successful Requests

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

Failed Requests

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

Errors

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

Ruckus Wireless Error Codes

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

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

Not Support URIs

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

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

Usage for Query Criteria

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

Change Logs

  • What’s New

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

  • What’s Deprecated

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

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

Login Session

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

Logon

POST/v5_1/session

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

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

Logoff

DELETE/v5_1/session

Use this API command to log off of the controller.

Response  200

Retrieve

GET/v5_1/session

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

Response  200
HideShow
Body
{
  "cpId": "DEV_BLADE_UUID",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "adminRoleId": "69962d35-9447-41a1-aff5-facf1e85c674",
  "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "adminId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "clientIp": "172.18.193.1",
  "apiVersions": [
    "1_0"
  ],
  "timeZoneUtcOffset": 0
}
Schema
{
  "type": "object",
  "properties": {
    "cpId": {
      "type": "string"
    },
    "domainId": {
      "type": "string"
    },
    "adminRoleId": {
      "type": "string"
    },
    "mvnoId": {
      "type": "string"
    },
    "adminId": {
      "type": "string"
    },
    "clientIp": {
      "type": "string"
    },
    "apiVersions": {
      "description": "API version supported by the client",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "timeZoneUtcOffset": {
      "type": "integer"
    }
  }
}

Ruckus Wireless AP Zone

Retrieve List

GET/v5_1/rkszones

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

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

domainId
string (optional) 

The domain ID. Default: current logon domain ID

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "zoneUUID",
      "name": "zoneName"
    },
    {
      "id": "zoneUUID2",
      "name": "zoneName2"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the zone",
            "type": "string"
          },
          "name": {
            "description": "Name of the zone",
            "type": "string"
          },
          "serviceName": {
            "description": "Name of the zone",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve

GET/v5_1/rkszones/{id}

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

Response  200
HideShow
Body
{
  "id": "ad5ffab1-b3ed-4b36-b054-bc723a977dbb",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "public-api-zone-ipv6",
  "description": null,
  "countryCode": "US",
  "version": "3.1.0.0.55",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "ipMode": "IPV6",
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "mesh": null,
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ],
    "availableChannelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ],
    "availableIndoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "availableOutdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "syslog": null,
  "smartMonitor": null,
  "clientAdmissionControl24": null,
  "clientAdmissionControl50": null,
  "channelModeEnabled": false,
  "tunnelType": "SoftGREIpsec",
  "tunnelProfile": {
    "id": "tunnelProfileId",
    "name": "tunnelProfileName"
  },
  "backgroundScanning24": null,
  "backgroundScanning50": null,
  "clientLoadBalancing24": null,
  "clientLoadBalancing50": null,
  "bandBalancing": null,
  "rogue": null,
  "locationBasedService": null,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": null,
  "locationAdditionalInfo": null,
  "latitude": null,
  "longitude": null,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": null,
  "venueProfile": null,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "autoPurgeExpiredDpsk": "OneDay",
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "recoverySsid": {
    "recoverySsidEnable": 1,
    "recoverySsidPskKey": "556612345"
  },
  "dhcpSiteConfig": {
    "zoneName": "zoneK",
    "siteEnabled": true,
    "manualSelect": true,
    "siteMode": "EnableOnMultipleAPs",
    "siteAps": [
      {
        "apMac": "38:FF:36:00:0E:10",
        "apServerEnabled": true,
        "apServerPrimary": true
      },
      {
        "apMac": "58:FF:36:00:0E:20",
        "apServerEnabled": true,
        "apServerPrimary": false
      }
    ],
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            },
            "description" : "GPS Altitude"
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            },
            "description" : "ap Management Vlan of the zone"
        },
        "apRebootTimeout" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            },
            "description" : "AP reboot timeout of the zone."
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 5G, auto channel selection mode"
        },
        "backgroundScanning24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "description" : "Background scanning on 2.4GHz radio configuration of the zone."
        },
        "backgroundScanning50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "description" : "Background scanning on 5GHz radio configuration of the zone."
        },
        "bandBalancing" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "Band balancing configuration of the zone."
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Bonjour Fencing Policy on the AP"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "channelEvaluationInterval" : {
            "default" : 600,
            "description" : "channel evaluation Interval of the zone",
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "channelModeEnabled" : {
            "description" : "Channel mode configuration of the zone.",
            "type" : "boolean"
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "AP client admission control 2.4GHz radio configuration of the zone."
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "AP client admission control 5GHz radio configuration of the zone."
        },
        "clientLoadBalancing24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            },
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone."
        },
        "clientLoadBalancing50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            },
            "description" : "Client load balancing on 5GHz radio configuration of the zone."
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the zone"
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs" ]
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "DHCP Site Config in Zone"
        },
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "id" : {
            "description" : "Identifier of the zone",
            "type" : "string"
        },
        "ipMode" : {
            "enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ],
            "description" : "IP mode of the zone"
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "ipsec profile configuration of the Zone."
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the zone"
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the Zone."
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Location additional info of the zone."
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Location based service configuration of the zone."
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
                    "description" : "User name of the AP administrator"
                },
                "apLoginPassword" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
                    "description" : "Password of the AP administrator"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ],
            "description" : "AP administrator account"
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the zone"
        },
        "mesh" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                }
            },
            "description" : "Mesh configuration of the zone."
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the zone"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Node affinity profile of the zone."
        },
        "rogue" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Rogue AP detection configuration of the zone."
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            },
            "description" : "Smart monitor configuration of the zone."
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "address" : {
                    "type" : "string",
                    "description" : "Address of the syslog server."
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            },
            "description" : "Syslog configuration of the zone."
        },
        "timezone" : {
            "additionalProperties" : false,
            "properties" : {
                "customizedTimezone" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset ",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ],
                            "description" : "Daylight saving time start"
                        },
                        "end" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ],
                            "description" : "Daylight saving time end"
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ],
                    "description" : "User defined time zone"
                }
            },
            "type" : "object",
            "description" : "Time zone"
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Tunnel type configuration of the zone."
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "usbSoftwarePackage" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "usbSoftware" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "APUsbSoftwarePackage id or name"
                },
                "applyModel" : {
                    "description" : "List of apply models",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "APUsbSoftwarePackage of the zone"
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "venue profile configuration of the Zone."
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
            "description" : "AP firmware version of the zone"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "description" : "AP 2.4GHz radio configuration of the zone."
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableIndoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableOutdoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "description" : "AP 5GHz radio configuration of the zone."
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            },
            "description" : "AP SNMP Options"
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            },
            "description" : "Recovery SSID"
        }
    },
    "type" : "object"
}

Create Zone

POST/v5_1/rkszones

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

Request
HideShow
Body
{
  "domainId": "domainUUID",
  "name": "zoneName",
  "description": "description Zone",
  "version": "3.0.0.0.145",
  "countryCode": "US",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "login": {
    "apLoginName": "apLoginName",
    "apLoginPassword": "apLoginPassword"
  },
  "mesh": {
    "ssid": "meshSSID"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "syslog": {
    "address": "1.1.1.1",
    "port": 514,
    "facility": "keep_Original",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "tunnelProfile": {
    "id": "tunnelProfileId",
    "name": "tunnelProfileName"
  },
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "clientLoadBalancing24": {
    "adjacentRadioThreshold": 12
  },
  "clientLoadBalancing50": {
    "adjacentRadioThreshold": 12
  },
  "bandBalancing": {
    "wifi24Percentage": 10
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "locationBasedService": {
    "id": "lbsId",
    "name": "lbsName"
  },
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": {
    "id": "nodeAffinityProfileId",
    "name": "nodeAffinityProfileName"
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnable": 1,
    "recoverySsidPskKey": "556612345"
  },
  "dhcpSiteConfig": {
    "multiSample": [
      {
        "sampleDescription": "DHCP Site Configuration when DHCP Service mode is EnableOnEachAPs",
        "sampleJson": {
          "siteEnabled": true,
          "siteMode": "EnableOnEachAPs",
          "siteProfileIds": [
            "75e26590-547f-11e6-9ca7-5a095364c13c",
            "869bb532-547f-11e6-9ca7-5a095364c13c"
          ]
        }
      },
      {
        "sampleDescription": "DHCP Site Configuration when DHCP Service mode is EnableOnMultipleAPs",
        "sampleJson": {
          "siteEnabled": true,
          "manualSelect": true,
          "siteMode": "EnableOnMultipleAPs",
          "siteAps": [
            {
              "apMac": "38:FF:36:00:0E:10",
              "apServerEnabled": true,
              "apServerPrimary": true
            },
            {
              "apMac": "58:FF:36:00:0E:20",
              "apServerEnabled": true,
              "apServerPrimary": false
            }
          ],
          "siteProfileIds": [
            "75e26590-547f-11e6-9ca7-5a095364c13c",
            "869bb532-547f-11e6-9ca7-5a095364c13c"
          ]
        }
      }
    ]
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the zone"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the zone"
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
            "description" : "AP firmware version of the zone"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
                    "description" : "User name of the AP administrator"
                },
                "apLoginPassword" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
                    "description" : "Password of the AP administrator"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ],
            "description" : "AP administrator account"
        },
        "timezone" : {
            "additionalProperties" : false,
            "properties" : {
                "customizedTimezone" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset ",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ],
                            "description" : "Daylight saving time start"
                        },
                        "end" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ],
                            "description" : "Daylight saving time end"
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ],
                    "description" : "User defined time zone"
                }
            },
            "type" : "object",
            "description" : "Either systemTimezone or customizedTimezone must be specified"
        },
        "mesh" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                }
            },
            "description" : "Mesh configuration of the zone."
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "description" : "AP 2.4GHz radio configuration of the zone."
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "description" : "AP 5GHz radio configuration of the zone."
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "address" : {
                    "type" : "string",
                    "description" : "Address of the syslog server."
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            },
            "description" : "Syslog configuration of the zone."
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            },
            "description" : "Smart monitor configuration of the zone."
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "AP client admission control 2.4GHz radio configuration of the zone."
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "AP client admission control 5GHz radio configuration of the zone."
        },
        "channelModeEnabled" : {
            "description" : "Channel mode configuration of the zone.",
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Tunnel type configuration of the zone."
        },
        "backgroundScanning24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "description" : "Background scanning on 2.4GHz radio configuration of the zone."
        },
        "backgroundScanning50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "description" : "Background scanning on 5GHz radio configuration of the zone."
        },
        "clientLoadBalancing24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            },
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone."
        },
        "clientLoadBalancing50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            },
            "description" : "Client load balancing on 5GHz radio configuration of the zone."
        },
        "bandBalancing" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "Band balancing configuration of the zone."
        },
        "rogue" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Rogue AP detection configuration of the zone."
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Location based service configuration of the zone."
        },
        "apRebootTimeout" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            },
            "description" : "AP reboot timeout of the zone."
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the zone."
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Location additional info of the zone."
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            },
            "description" : "GPS Altitude"
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the zone"
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the zone"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Node affinity profile of the zone."
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Venue profile configuration of the zone."
        },
        "usbSoftwarePackage" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "usbSoftware" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "APUsbSoftwarePackage id or name"
                },
                "applyModel" : {
                    "description" : "List of apply models",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "APUsbSoftwarePackage of the zone"
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 5G, auto channel selection mode"
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            },
            "description" : "ap Management Vlan of the zone"
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "ipsec profile configuration of the Zone."
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Bonjour Fencing Policy on the AP"
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs" ]
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "DHCP Site Configuration in Zone"
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            },
            "description" : "AP SNMP Options"
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            },
            "description" : "Recovery SSID"
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the zone",
      "type": "string"
    }
  }
}

Create Zone of IPv6

POST/v5_1/rkszones/ipv6

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

Request
HideShow
Body
{
  "domainId": "domainUUID",
  "name": "zoneName",
  "description": "description Zone",
  "version": "3.0.0.0.145",
  "countryCode": "US",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "login": {
    "apLoginName": "apLoginName",
    "apLoginPassword": "apLoginPassword"
  },
  "mesh": {
    "ssid": "meshSSID"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "syslog": {
    "address": "1.1.1.1",
    "port": 514,
    "facility": "keep_Original",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "tunnelProfile": {
    "id": "tunnelProfileId",
    "name": "tunnelProfileName"
  },
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "clientLoadBalancing24": {
    "adjacentRadioThreshold": 12
  },
  "clientLoadBalancing50": {
    "adjacentRadioThreshold": 12
  },
  "bandBalancing": {
    "wifi24Percentage": 10
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "locationBasedService": {
    "id": "lbsId",
    "name": "lbsName"
  },
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": {
    "id": "nodeAffinityProfileId",
    "name": "nodeAffinityProfileName"
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnable": 1,
    "recoverySsidPskKey": "556612345"
  },
  "dhcpSiteConfig": {
    "multiSample": [
      {
        "sampleDescription": "DHCP Site Configuration when DHCP Service mode is EnableOnEachAPs",
        "sampleJson": {
          "siteEnabled": true,
          "siteMode": "EnableOnEachAPs",
          "siteProfileIds": [
            "75e26590-547f-11e6-9ca7-5a095364c13c",
            "869bb532-547f-11e6-9ca7-5a095364c13c"
          ]
        }
      },
      {
        "sampleDescription": "DHCP Site Configuration when DHCP Service mode is EnableOnMultipleAPs",
        "sampleJson": {
          "siteEnabled": true,
          "manualSelect": true,
          "siteMode": "EnableOnMultipleAPs",
          "siteAps": [
            {
              "apMac": "38:FF:36:00:0E:10",
              "apServerEnabled": true,
              "apServerPrimary": true
            },
            {
              "apMac": "58:FF:36:00:0E:20",
              "apServerEnabled": true,
              "apServerPrimary": false
            }
          ],
          "siteProfileIds": [
            "75e26590-547f-11e6-9ca7-5a095364c13c",
            "869bb532-547f-11e6-9ca7-5a095364c13c"
          ]
        }
      }
    ]
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the zone"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the zone"
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
            "description" : "AP firmware version of the zone"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
                    "description" : "User name of the AP administrator"
                },
                "apLoginPassword" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
                    "description" : "Password of the AP administrator"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ],
            "description" : "AP administrator account"
        },
        "timezone" : {
            "additionalProperties" : false,
            "properties" : {
                "customizedTimezone" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset ",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ],
                            "description" : "Daylight saving time start"
                        },
                        "end" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ],
                            "description" : "Daylight saving time end"
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ],
                    "description" : "User defined time zone"
                }
            },
            "type" : "object",
            "description" : "Either systemTimezone or customizedTimezone must be specified"
        },
        "mesh" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                }
            },
            "description" : "Mesh configuration of the zone."
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "description" : "AP 2.4GHz radio configuration of the zone."
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "description" : "AP 5GHz radio configuration of the zone."
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "address" : {
                    "type" : "string",
                    "description" : "Address of the syslog server."
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            },
            "description" : "Syslog configuration of the zone."
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            },
            "description" : "Smart monitor configuration of the zone."
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "AP client admission control 2.4GHz radio configuration of the zone."
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "AP client admission control 5GHz radio configuration of the zone."
        },
        "channelModeEnabled" : {
            "description" : "Channel mode configuration of the zone.",
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Tunnel type configuration of the zone."
        },
        "backgroundScanning24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "description" : "Background scanning on 2.4GHz radio configuration of the zone."
        },
        "backgroundScanning50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "description" : "Background scanning on 5GHz radio configuration of the zone."
        },
        "clientLoadBalancing24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            },
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone."
        },
        "clientLoadBalancing50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            },
            "description" : "Client load balancing on 5GHz radio configuration of the zone."
        },
        "bandBalancing" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "Band balancing configuration of the zone."
        },
        "rogue" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Rogue AP detection configuration of the zone."
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Location based service configuration of the zone."
        },
        "apRebootTimeout" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            },
            "description" : "AP reboot timeout of the zone."
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the zone."
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Location additional info of the zone."
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            },
            "description" : "GPS Altitude"
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the zone"
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the zone"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Node affinity profile of the zone."
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Venue profile configuration of the zone."
        },
        "usbSoftwarePackage" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "usbSoftware" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "APUsbSoftwarePackage id or name"
                },
                "applyModel" : {
                    "description" : "List of apply models",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "APUsbSoftwarePackage of the zone"
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 5G, auto channel selection mode"
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            },
            "description" : "ap Management Vlan of the zone"
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "ipsec profile configuration of the Zone."
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Bonjour Fencing Policy on the AP"
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs" ]
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "DHCP Site Configuration in Zone"
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            },
            "description" : "AP SNMP Options"
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            },
            "description" : "Recovery SSID"
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the zone",
      "type": "string"
    }
  }
}

Create Zone of Dual

POST/v5_1/rkszones/dual

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

Request
HideShow
Body
{
  "domainId": "domainUUID",
  "name": "zoneName",
  "description": "description Zone",
  "version": "3.0.0.0.145",
  "countryCode": "US",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "login": {
    "apLoginName": "apLoginName",
    "apLoginPassword": "apLoginPassword"
  },
  "mesh": {
    "ssid": "meshSSID"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "syslog": {
    "address": "1.1.1.1",
    "port": 514,
    "facility": "keep_Original",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "tunnelProfile": {
    "id": "tunnelProfileId",
    "name": "tunnelProfileName"
  },
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "clientLoadBalancing24": {
    "adjacentRadioThreshold": 12
  },
  "clientLoadBalancing50": {
    "adjacentRadioThreshold": 12
  },
  "bandBalancing": {
    "wifi24Percentage": 10
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "locationBasedService": {
    "id": "lbsId",
    "name": "lbsName"
  },
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": {
    "id": "nodeAffinityProfileId",
    "name": "nodeAffinityProfileName"
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnable": 1,
    "recoverySsidPskKey": "556612345"
  },
  "dhcpSiteConfig": {
    "multiSample": [
      {
        "sampleDescription": "DHCP Site Configuration when DHCP Service mode is EnableOnEachAPs",
        "sampleJson": {
          "siteEnabled": true,
          "siteMode": "EnableOnEachAPs",
          "siteProfileIds": [
            "75e26590-547f-11e6-9ca7-5a095364c13c",
            "869bb532-547f-11e6-9ca7-5a095364c13c"
          ]
        }
      },
      {
        "sampleDescription": "DHCP Site Configuration when DHCP Service mode is EnableOnMultipleAPs",
        "sampleJson": {
          "siteEnabled": true,
          "manualSelect": true,
          "siteMode": "EnableOnMultipleAPs",
          "siteAps": [
            {
              "apMac": "38:FF:36:00:0E:10",
              "apServerEnabled": true,
              "apServerPrimary": true
            },
            {
              "apMac": "58:FF:36:00:0E:20",
              "apServerEnabled": true,
              "apServerPrimary": false
            }
          ],
          "siteProfileIds": [
            "75e26590-547f-11e6-9ca7-5a095364c13c",
            "869bb532-547f-11e6-9ca7-5a095364c13c"
          ]
        }
      }
    ]
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the zone"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the zone"
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
            "description" : "AP firmware version of the zone"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
                    "description" : "User name of the AP administrator"
                },
                "apLoginPassword" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
                    "description" : "Password of the AP administrator"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ],
            "description" : "AP administrator account"
        },
        "timezone" : {
            "additionalProperties" : false,
            "properties" : {
                "customizedTimezone" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset ",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ],
                            "description" : "Daylight saving time start"
                        },
                        "end" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ],
                            "description" : "Daylight saving time end"
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ],
                    "description" : "User defined time zone"
                }
            },
            "type" : "object",
            "description" : "Either systemTimezone or customizedTimezone must be specified"
        },
        "mesh" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                }
            },
            "description" : "Mesh configuration of the zone."
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "description" : "AP 2.4GHz radio configuration of the zone."
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "description" : "AP 5GHz radio configuration of the zone."
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "address" : {
                    "type" : "string",
                    "description" : "Address of the syslog server."
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            },
            "description" : "Syslog configuration of the zone."
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            },
            "description" : "Smart monitor configuration of the zone."
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "AP client admission control 2.4GHz radio configuration of the zone."
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "AP client admission control 5GHz radio configuration of the zone."
        },
        "channelModeEnabled" : {
            "description" : "Channel mode configuration of the zone.",
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Tunnel type configuration of the zone."
        },
        "backgroundScanning24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "description" : "Background scanning on 2.4GHz radio configuration of the zone."
        },
        "backgroundScanning50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "description" : "Background scanning on 5GHz radio configuration of the zone."
        },
        "clientLoadBalancing24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            },
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone."
        },
        "clientLoadBalancing50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            },
            "description" : "Client load balancing on 5GHz radio configuration of the zone."
        },
        "bandBalancing" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "Band balancing configuration of the zone."
        },
        "rogue" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Rogue AP detection configuration of the zone."
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Location based service configuration of the zone."
        },
        "apRebootTimeout" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            },
            "description" : "AP reboot timeout of the zone."
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the zone."
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Location additional info of the zone."
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            },
            "description" : "GPS Altitude"
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the zone"
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the zone"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Node affinity profile of the zone."
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Venue profile configuration of the zone."
        },
        "usbSoftwarePackage" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "usbSoftware" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "APUsbSoftwarePackage id or name"
                },
                "applyModel" : {
                    "description" : "List of apply models",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "APUsbSoftwarePackage of the zone"
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 5G, auto channel selection mode"
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            },
            "description" : "ap Management Vlan of the zone"
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "ipsec profile configuration of the Zone."
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Bonjour Fencing Policy on the AP"
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs" ]
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "DHCP Site Configuration in Zone"
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            },
            "description" : "AP SNMP Options"
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            },
            "description" : "Recovery SSID"
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the zone",
      "type": "string"
    }
  }
}

Delete

DELETE/v5_1/rkszones/{id}

Use this API command to delete a zone.

Response  204

Retrieve Mesh Configuration

GET/v5_1/rkszones/{id}/mesh

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

Response  200
HideShow
Body
{
  "ssid": "meshSSID",
  "passphrase": "passphrase"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ssid": {
      "description": "SSID of the mesh network",
      "type": "string"
    },
    "passphrase": {
      "description": "Passphrase for the mesh network",
      "type": "string"
    }
  }
}

Modify Mesh Configuration

PATCH/v5_1/rkszones/{id}/mesh

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

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

Clear Mesh Configuration

DELETE/v5_1/rkszones/{id}/mesh

Use this API command to disable mesh networking.

Response  204

Modify Basic

PATCH/v5_1/rkszones/{id}

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

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

Modify Time Zone

PATCH/v5_1/rkszones/{id}/timezone

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

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

Follow System Time Zone

DELETE/v5_1/rkszones/{id}/timezone

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

Response  204

Modify AP Logon

PATCH/v5_1/rkszones/{id}/login

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

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

Modify Radio 2.4G

PATCH/v5_1/rkszones/{id}/wifi24

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

Request
HideShow
Body
{
  "txPower": "Full",
  "channelWidth": 20,
  "channel": 0,
  "channelRange": [
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8,
    9,
    10,
    11
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "txPower": {
      "enum": [
        "Full",
        "-1dB",
        "-2dB",
        "-3dB(1/2)",
        "-4dB",
        "-5dB",
        "-6dB(1/4)",
        "-7dB",
        "-8dB",
        "-9dB(1/8)",
        "-10dB",
        "Min"
      ],
      "description": "Transmission power"
    },
    "channelWidth": {
      "description": "Channel width. Zero (0) means Auto.",
      "enum": [
        0,
        20,
        40
      ]
    },
    "channel": {
      "description": "Channel number",
      "type": "integer"
    },
    "channelRange": {
      "description": "Channel range options",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "description": "AP 2.4GHz radio configuration of the zone."
}
Response  204

Modify Radio 5G

PATCH/v5_1/rkszones/{id}/wifi50

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

Request
HideShow
Body
{
  "txPower": "-1dB",
  "channelWidth": 40,
  "indoorChannel": 0,
  "outdoorChannel": 0,
  "indoorChannelRange": [
    36,
    40,
    44,
    48,
    149,
    153,
    157,
    161
  ],
  "outdoorChannelRange": [
    149,
    153,
    157,
    161
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "txPower": {
      "enum": [
        "Full",
        "-1dB",
        "-2dB",
        "-3dB(1/2)",
        "-4dB",
        "-5dB",
        "-6dB(1/4)",
        "-7dB",
        "-8dB",
        "-9dB(1/8)",
        "-10dB",
        "Min"
      ],
      "description": "Transmission power"
    },
    "channelWidth": {
      "description": "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
      "enum": [
        0,
        20,
        40,
        80,
        8080,
        160
      ]
    },
    "indoorChannel": {
      "description": "Channel number for Indoor AP",
      "type": "integer"
    },
    "outdoorChannel": {
      "description": "Channel number for Outdoor AP",
      "type": "integer"
    },
    "indoorSecondaryChannel": {
      "description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
      "type": "integer"
    },
    "outdoorSecondaryChannel": {
      "description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
      "type": "integer"
    },
    "indoorChannelRange": {
      "description": "Channel range options for Indoor AP",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "outdoorChannelRange": {
      "description": "Channel range options for outdoor AP",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "description": "AP 5GHz radio configuration of the zone."
}
Response  204

Modify Syslog

PATCH/v5_1/rkszones/{id}/syslog

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

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

Disable Syslog

DELETE/v5_1/rkszones/{id}/syslog

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

Response  204

Modify Smart Monitor

PATCH/v5_1/rkszones/{id}/smartMonitor

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

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

Disable Smart Monitor

DELETE/v5_1/rkszones/{id}/smartMonitor

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

Response  204

Modify Client Admission Control 2.4G

PATCH/v5_1/rkszones/{id}/clientAdmissionControl24

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

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

Disable Client Admission Control 2.4G

DELETE/v5_1/rkszones/{id}/clientAdmissionControl24

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

Response  204

Modify Client Admission Control 5G

PATCH/v5_1/rkszones/{id}/clientAdmissionControl50

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

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

Disable Client Admission Control 5G

DELETE/v5_1/rkszones/{id}/clientAdmissionControl50

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

Response  204

Modify Background Scanning 2.4G

PATCH/v5_1/rkszones/{id}/backgroundScanning24

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

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

Disable Background Scanning 2.4G

DELETE/v5_1/rkszones/{id}/backgroundScanning24

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

Response  204

Modify Background Scanning 5G

PATCH/v5_1/rkszones/{id}/backgroundScanning50

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

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

Disable Background Scanning 5G

DELETE/v5_1/rkszones/{id}/backgroundScanning50

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

Response  204

Modify Client Load Balancing 2.4G

PATCH/v5_1/rkszones/{id}/clientLoadBalancing24

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

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

Disable Client Load Balancing 2.4G

DELETE/v5_1/rkszones/{id}/clientLoadBalancing24

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

Response  204

Modify Client Load Balancing 5G

PATCH/v5_1/rkszones/{id}/clientLoadBalancing50

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

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

Disable Client Load Balancing 5G

DELETE/v5_1/rkszones/{id}/clientLoadBalancing50

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

Response  204

Modify Band Balancing

PATCH/v5_1/rkszones/{id}/bandBalancing

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

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

Disable Band Balancing

DELETE/v5_1/rkszones/{id}/bandBalancing

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

Response  204

Modify AP Reboot Timeout

PATCH/v5_1/rkszones/{id}/apRebootTimeout

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

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

Modify Node Affinity Profile

PATCH/v5_1/rkszones/{id}/nodeAffinityProfile

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

Request
HideShow
Body
{
  "id": "nodeAffinityProfileId",
  "name": "nodeAffinityProfileName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Node affinity profile of the zone."
}
Response  204

Modify Hotspot2.0 Venue Profile

PATCH/v5_1/rkszones/{id}/venueProfile

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

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

Clear Hotspot2.0 Venue Profile

DELETE/v5_1/rkszones/{id}/venueProfile

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

Response  204

Modify Rogue

PATCH/v5_1/rkszones/{id}/rogue

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

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

Disable Rogue

DELETE/v5_1/rkszones/{id}/rogue

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

Response  204

Modify Location Based Service

PATCH/v5_1/rkszones/{id}/locationBasedService

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

Request
HideShow
Body
{
  "id": "lbsId",
  "name": "lbsName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Location based service configuration of the zone."
}
Response  204

Disable Location Based Service

DELETE/v5_1/rkszones/{id}/locationBasedService

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

Response  204

Retrieve AP Model

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

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

Response  200
HideShow
Body
{
  "ledStatusEnabled": true,
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 30,
    "holdTimeInSec": 120,
    "managementIPTLVEnabled": false
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN1",
      "enabled": false,
      "ethPortProfile": null
    },
    {
      "portName": "LAN2",
      "enabled": true,
      "ethPortProfile": {
        "id": "0",
        "name": "Default Trunk Port"
      }
    },
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1",
        "name": "Default Access Port"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ledStatusEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "lldp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "advertiseIntervalInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 300
        },
        "holdTimeInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 60,
          "maximum": 1200
        },
        "managementIPTLVEnabled": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "ledMode": {
      "enum": [
        null,
        "CableModem",
        "AccessPoint",
        "CableModem_AccessPoint",
        "CableModem_AccessPoint_DEFAULT",
        "ActiveSurgeProtector",
        "ActiveSurgeProtector_ModemOnline_DEFAULT",
        "Off"
      ]
    },
    "internalHeaterEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeOutPortEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "usbPowerEnable": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeModeSetting": {
      "enum": [
        null,
        "Auto",
        "_802_3af",
        "_802_3at",
        "_802_3atPlus"
      ]
    },
    "poeTxChain": {
      "description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
      "default": 2,
      "type": [
        "integer",
        "null"
      ]
    },
    "radioBand": {
      "description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
      "enum": [
        null,
        "2.4GHz",
        "5GHz"
      ]
    },
    "externalAntenna24": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "externalAntenna50": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lanPorts": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "portName": {
            "enum": [
              "LAN1",
              "LAN2",
              "LAN3",
              "LAN4",
              "LAN5"
            ]
          },
          "enabled": {
            "type": "boolean"
          },
          "ethPortProfile": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "portName",
          "enabled"
        ]
      }
    }
  }
}

Modify AP Model

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

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

Request
HideShow
Body
{
  "ledStatusEnabled": true,
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 30,
    "holdTimeInSec": 120,
    "managementIPTLVEnabled": false
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN1",
      "enabled": false,
      "ethPortProfile": null
    },
    {
      "portName": "LAN2",
      "enabled": true,
      "ethPortProfile": {
        "id": "0",
        "name": "Default Trunk Port"
      }
    },
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1",
        "name": "Default Access Port"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ledStatusEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "lldp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "advertiseIntervalInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 300
        },
        "holdTimeInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 60,
          "maximum": 1200
        },
        "managementIPTLVEnabled": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "ledMode": {
      "enum": [
        null,
        "CableModem",
        "AccessPoint",
        "CableModem_AccessPoint",
        "CableModem_AccessPoint_DEFAULT",
        "ActiveSurgeProtector",
        "ActiveSurgeProtector_ModemOnline_DEFAULT",
        "Off"
      ]
    },
    "internalHeaterEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeOutPortEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "usbPowerEnable": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeModeSetting": {
      "enum": [
        null,
        "Auto",
        "_802_3af",
        "_802_3at",
        "_802_3atPlus"
      ]
    },
    "poeTxChain": {
      "description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
      "default": 2,
      "type": [
        "integer",
        "null"
      ]
    },
    "radioBand": {
      "description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
      "enum": [
        null,
        "2.4GHz",
        "5GHz"
      ]
    },
    "externalAntenna24": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "externalAntenna50": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lanPorts": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "portName": {
            "enum": [
              "LAN1",
              "LAN2",
              "LAN3",
              "LAN4",
              "LAN5"
            ]
          },
          "enabled": {
            "type": "boolean"
          },
          "ethPortProfile": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "portName",
          "enabled"
        ]
      }
    }
  }
}
Response  204

Retrieve AP Model Common Attribute

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

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

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

Modify Radio 2.4G Auto ChannelSelectMode

PATCH/v5_1/rkszones/{id}/autoChannelSelection24

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

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

Modify Radio 5G Auto ChannelSelectMode

PATCH/v5_1/rkszones/{id}/autoChannelSelection50

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

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

Modify IPsec Profile

PATCH/v5_1/rkszones/{id}/ipsecProfile

Modify IPsec Profile of a zone.

Request
HideShow
Body
{
  "id": "ipsecProfileId",
  "name": "ipsecProfileName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "ipsec profile configuration of the Zone."
}
Response  204

Modify AP Usb Software Package

PATCH/v5_1/rkszones/{id}/usbSoftwarePackage

Modify AP Usb Software Package of a zone.

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

Modify AP Management Vlan

PATCH/v5_1/rkszones/{id}/apMgmtVlan

Modify AP Management Vlan of a zone.

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

Disable AP Usb Software Package

DELETE/v5_1/rkszones/{id}/usbSoftwarePackage

Disable AP Usb Software Package of a zone.

URI Parameters
HideShow
applyModel
string (optional) 

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

Response  204

Modify Altitude

PATCH/v5_1/rkszones/{id}/altitude

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

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

Disable Altitude

DELETE/v5_1/rkszones/{id}/altitude

Use this API command to disable altitude configuration of zone.

Response  204

Retrieve AP Firmware List

GET/v5_1/rkszones/{zoneId}/apFirmware

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

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

Change AP Firmware

PUT/v5_1/rkszones/{zoneId}/apFirmware

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

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

Modify AP SNMP Options

PATCH/v5_1/rkszones/{id}/snmpAgent

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

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

Clear AP SNMP Options

DELETE/v5_1/rkszones/{id}/snmpAgent

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

Response  204

Modify zone recovery SSID

PATCH/v5_1/rkszones/{id}/recoverySsid

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

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

Disable zone recovery SSID

DELETE/v5_1/rkszones/{id}/recoverySsid

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

Response  204

Modify DHCP/NAT service configuration

PATCH/v5_1/rkszones/{id}/dhcpSiteConfig

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

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

Retrieve DHCP/NAT service IP assignment

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

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

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

Retrieve DHCP/NAT service configuration within Domain

POST/v5_1/rkszones/services/dhcpSiteConfig/query

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

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

Modify Bonjour Fencing Policy configuration

PATCH/v5_1/rkszones/{id}/bonjourFencingPolicy

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

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

Modify tunnel profile

PATCH/v5_1/rkszones/{id}/tunnelProfile

Use this API command to change tunnel profile of Zone.

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

AP Group

Retrieve List

GET/v5_1/rkszones/{zoneId}/apgroups

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

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "apGroupUUID",
      "name": "apGroupName"
    },
    {
      "id": "apGroupUUID2",
      "name": "apGroupName2"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the AP group",
            "type": "string"
          },
          "name": {
            "description": "Description of the AP group",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve

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

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

Response  200
HideShow
Body
{
  "id": "apGroupUUID",
  "zoneId": "zoneUUID",
  "name": "apGroupName",
  "description": "apGroupDescription",
  "location": "test-ap1_modify",
  "locationAdditionalInfo": "add",
  "latitude": 34,
  "longitude": 45,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 9,
    "channelRange": [
      1,
      2,
      3,
      4,
      9,
      10,
      11
    ],
    "availableChannelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "Full",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 157,
    "indoorChannelRange": [
      36,
      40,
      44,
      48
    ],
    "outdoorChannelRange": [
      149,
      153
    ],
    "availableIndoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "availableOutdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "wlanGroup24": {
    "id": "19b10850-7eaa-11e4-a584-08002716c79f",
    "name": "default"
  },
  "wlanGroup50": null,
  "locationBasedService": null,
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": null,
  "venueProfile": null,
  "members": [
    {
      "apMac": "00:11:22:33:44:55"
    },
    {
      "apMac": "11:22:33:44:55:66"
    }
  ],
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the AP group",
            "type" : "string"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the AP group belongs",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the AP group",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the AP group",
            "type" : "string"
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the AP group."
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Location additional info of the AP group."
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            },
            "description" : "GPS Altitude"
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the AP group"
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the AP group"
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "description" : "AP 2.4GHz radio configuration of the AP group."
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableIndoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableOutdoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "description" : "AP 5GHz radio configuration of the AP group."
        },
        "wlanGroup24" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "WLAN group of radio 2.4G. This configuraiton will override the WLAN group of radio 2.4G at the zone level."
        },
        "wlanGroup50" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "WLAN group of radio 5G. This configuration will override the WLAN group of radio 5G at the zone level."
        },
        "locationBasedService" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Location based service configuration of the AP group."
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level."
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level."
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Venue profile configuration of the AP group."
        },
        "members" : {
            "description" : "Members of the AP group",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "apMac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "MAC address of member AP"
                    }
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 5G, auto channel selection mode"
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the ap group",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            },
            "description" : "ap Management Vlan of the apgroup"
        },
        "awsVenue" : {
            "description" : "Venue code",
            "type" : "string"
        }
    },
    "required" : [ "name" ]
}

Create

POST/v5_1/rkszones/{zoneId}/apgroups

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

Request
HideShow
Body
{
  "name": "apGroupName",
  "description": "apGroupDescription"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the AP group"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the AP group"
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "apGroupUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the AP group",
      "type": "string"
    }
  }
}

Modify Basic

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

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

Request
HideShow
Body
{
  "name": "apGroupNameModified",
  "description": "apGroupDescriptionModified",
  "location": "test-ap1_modify",
  "locationAdditionalInfo": "add",
  "latitude": 34,
  "longitude": 45,
  "channelEvaluationInterval": 777
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the AP group"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the AP group"
  },
  "location": {
    "type": "string",
    "pattern": "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Location of the AP group."
  },
  "locationAdditionalInfo": {
    "type": "string",
    "pattern": "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
    "description": "Location additional info of the AP group."
  },
  "latitude": {
    "type": "number",
    "description": "Latitude coordinate (in decimal format) of the AP group"
  },
  "longitude": {
    "type": "number",
    "description": "Longitude coordinate (in decimal format) of the AP group"
  },
  "channelEvaluationInterval": {
    "description": "channel evaluation Interval of the ap group",
    "type": "integer",
    "default": 600,
    "minimum": 60,
    "maximum": 3600
  },
  "awsVenue": {
    "description": "Venue code",
    "type": "string"
  }
}
Response  204

Retrieve

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

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

Response  200
HideShow
Body
{
  "id": "apGroupUUID",
  "zoneId": "zoneUUID",
  "name": "apGroupName",
  "description": "apGroupDescription",
  "location": "test-ap1_modify",
  "locationAdditionalInfo": "add",
  "latitude": 34,
  "longitude": 45,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 9,
    "channelRange": [
      1,
      2,
      3,
      4,
      9,
      10,
      11
    ],
    "availableChannelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "Full",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 157,
    "indoorChannelRange": [
      36,
      40,
      44,
      48
    ],
    "outdoorChannelRange": [
      149,
      153
    ],
    "availableIndoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "availableOutdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "wlanGroup24": {
    "id": "19b10850-7eaa-11e4-a584-08002716c79f",
    "name": "default"
  },
  "wlanGroup50": null,
  "locationBasedService": null,
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": null,
  "venueProfile": null,
  "members": [
    {
      "apMac": "00:11:22:33:44:55"
    },
    {
      "apMac": "11:22:33:44:55:66"
    }
  ],
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the AP group",
            "type" : "string"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the AP group belongs",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the AP group",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the AP group",
            "type" : "string"
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the AP group."
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Location additional info of the AP group."
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            },
            "description" : "GPS Altitude"
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the AP group"
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the AP group"
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "description" : "AP 2.4GHz radio configuration of the AP group."
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableIndoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableOutdoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "description" : "AP 5GHz radio configuration of the AP group."
        },
        "wlanGroup24" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "WLAN group of radio 2.4G. This configuraiton will override the WLAN group of radio 2.4G at the zone level."
        },
        "wlanGroup50" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "WLAN group of radio 5G. This configuration will override the WLAN group of radio 5G at the zone level."
        },
        "locationBasedService" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Location based service configuration of the AP group."
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level."
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level."
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Venue profile configuration of the AP group."
        },
        "members" : {
            "description" : "Members of the AP group",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "apMac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "MAC address of member AP"
                    }
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 5G, auto channel selection mode"
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the ap group",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            },
            "description" : "ap Management Vlan of the apgroup"
        },
        "awsVenue" : {
            "description" : "Venue code",
            "type" : "string"
        }
    },
    "required" : [ "name" ]
}

Disable Location Override

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/location

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

Response  204

Disable Location AdditionalInfo Override

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/locationAdditionalInfo

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

Response  204

Modify Radio 2.4G Override

PATCH/v5_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.

Request
HideShow
Body
{
  "txPower": "Full",
  "channelWidth": 20,
  "channel": 10,
  "channelRange": [
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8,
    9,
    10,
    11
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "txPower": {
      "enum": [
        "Full",
        "-1dB",
        "-2dB",
        "-3dB(1/2)",
        "-4dB",
        "-5dB",
        "-6dB(1/4)",
        "-7dB",
        "-8dB",
        "-9dB(1/8)",
        "-10dB",
        "Min"
      ],
      "description": "Transmission power"
    },
    "channelWidth": {
      "description": "Channel width. Zero (0) means Auto.",
      "enum": [
        0,
        20,
        40
      ]
    },
    "channel": {
      "description": "Channel number",
      "type": "integer"
    },
    "channelRange": {
      "description": "Channel range options",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "description": "AP 2.4GHz radio configuration of the AP group."
}
Response  204

Disable Radio 2.4G Override

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/wifi24

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

Response  204

Disable Radio 2.4G TxPower Override

DELETE/v5_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.

Response  204

Disable Radio 2.4G ChannelWidth Override

DELETE/v5_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.

Response  204

Disable Radio 2.4G Channel Override

DELETE/v5_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.

Response  204

Disable Radio 2.4G ChannelRange Override

DELETE/v5_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.

Response  204

Modify Radio 5G Override

PATCH/v5_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.

Request
HideShow
Body
{
  "txPower": "Full",
  "channelWidth": 20,
  "indoorChannel": 36,
  "outdoorChannel": 149,
  "indoorChannelRange": [
    36,
    40,
    44,
    48,
    149,
    153,
    157,
    161
  ],
  "outdoorChannelRange": [
    149,
    153,
    157,
    161
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "txPower": {
      "enum": [
        "Full",
        "-1dB",
        "-2dB",
        "-3dB(1/2)",
        "-4dB",
        "-5dB",
        "-6dB(1/4)",
        "-7dB",
        "-8dB",
        "-9dB(1/8)",
        "-10dB",
        "Min"
      ],
      "description": "Transmission power"
    },
    "channelWidth": {
      "description": "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
      "enum": [
        0,
        20,
        40,
        80,
        8080,
        160
      ]
    },
    "indoorChannel": {
      "description": "Channel number for Indoor AP",
      "type": "integer"
    },
    "outdoorChannel": {
      "description": "Channel number for Outdoor AP",
      "type": "integer"
    },
    "indoorSecondaryChannel": {
      "description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
      "type": "integer"
    },
    "outdoorSecondaryChannel": {
      "description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
      "type": "integer"
    },
    "indoorChannelRange": {
      "description": "Channel range options for Indoor AP",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "outdoorChannelRange": {
      "description": "Channel range options for outdoor AP",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "description": "AP 5GHz radio configuration of the AP group."
}
Response  204

Disable Radio 5G Override

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/wifi50

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

Response  204

Disable Radio 5G TxPower Override

DELETE/v5_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.

Response  204

Disable Radio 5G ChannelWidth Override

DELETE/v5_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.

Response  204

Disable Radio 5G IndoorChannel Override

DELETE/v5_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.

Response  204

Disable Radio 5G OutdoorChannel Override

DELETE/v5_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.

Response  204

Disable Radio 5G IndoorChannelRange Override

DELETE/v5_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.

Response  204

Disable Radio 5G OutdoorChannelRange Override

DELETE/v5_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.

Response  204

Modify WLAN group 2.4G Override

PATCH/v5_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.

Request
HideShow
Body
{
  "id": "19b10850-7eaa-11e4-a584-08002716c79f",
  "name": "default"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level."
}
Response  204

Disable WLAN group 2.4G Override

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup24

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

Response  204

Modify WLAN group 5G Override

PATCH/v5_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.

Request
HideShow
Body
{
  "id": "19b10850-7eaa-11e4-a584-08002716c79f",
  "name": "default"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level."
}
Response  204

Disable WLAN group 5G Override

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup50

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

Response  204

Modify Location Based Service Override

PATCH/v5_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.

Request
HideShow
Body
{
  "id": "lbsServiceId",
  "name": "lbsServiceName"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Location based service configuration of the AP group."
}
Response  204

Disable Location Based Service Override

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/locationBasedService

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

Response  204

Modify Client Admission Control 2.4G Override

PATCH/v5_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.

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

Disable Client Admission Control 2.4G Override

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl24

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

Response  204

Modify Client Admission Control 5G Override

PATCH/v5_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.

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

Disable Client Admission Control 5G Override

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl50

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

Response  204

Modify Hotspot2.0 Venue Profile

PATCH/v5_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.

Request
HideShow
Body
{
  "id": "venueProfileId",
  "name": "venueProfileName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Venue profile configuration of the AP group."
}
Response  204

Clear Hotspot2.0 Venue Profile

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/venueProfile

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

Response  204

Add Member

POST/v5_1/rkszones/{zoneId}/apgroups/{id}/members/{apMac}

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

Response  201

Add Member List

POST/v5_1/rkszones/{zoneId}/apgroups/{id}/members

Add multiple members to an AP group.

Request
HideShow
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" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "MAC address of member AP"
                    }
                }
            }
        }
    }
}
Response  201

Remove Member

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/members/{apMac}

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

Response  204

Retrieve AP Model

GET/v5_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}

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

Response  200
HideShow
Body
{
  "ledStatusEnabled": true,
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 30,
    "holdTimeInSec": 120,
    "managementIPTLVEnabled": false
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN1",
      "enabled": false,
      "ethPortProfile": null
    },
    {
      "portName": "LAN2",
      "enabled": true,
      "ethPortProfile": {
        "id": "0",
        "name": "Default Trunk Port"
      }
    },
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1",
        "name": "Default Access Port"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ledStatusEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "lldp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "advertiseIntervalInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 300
        },
        "holdTimeInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 60,
          "maximum": 1200
        },
        "managementIPTLVEnabled": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "ledMode": {
      "enum": [
        null,
        "CableModem",
        "AccessPoint",
        "CableModem_AccessPoint",
        "CableModem_AccessPoint_DEFAULT",
        "ActiveSurgeProtector",
        "ActiveSurgeProtector_ModemOnline_DEFAULT",
        "Off"
      ]
    },
    "internalHeaterEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeOutPortEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "usbPowerEnable": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeModeSetting": {
      "enum": [
        null,
        "Auto",
        "_802_3af",
        "_802_3at",
        "_802_3atPlus"
      ]
    },
    "poeTxChain": {
      "description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
      "default": 2,
      "type": [
        "integer",
        "null"
      ]
    },
    "radioBand": {
      "description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
      "enum": [
        null,
        "2.4GHz",
        "5GHz"
      ]
    },
    "externalAntenna24": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "externalAntenna50": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lanPorts": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "portName": {
            "enum": [
              "LAN1",
              "LAN2",
              "LAN3",
              "LAN4",
              "LAN5"
            ]
          },
          "enabled": {
            "type": "boolean"
          },
          "ethPortProfile": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "portName",
          "enabled"
        ]
      }
    }
  }
}

Override AP Model

PUT/v5_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.

Request
HideShow
Body
{
  "ledStatusEnabled": true,
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 30,
    "holdTimeInSec": 120,
    "managementIPTLVEnabled": false
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN1",
      "enabled": false,
      "ethPortProfile": null
    },
    {
      "portName": "LAN2",
      "enabled": true,
      "ethPortProfile": {
        "id": "0",
        "name": "Default Trunk Port"
      }
    },
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1",
        "name": "Default Access Port"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ledStatusEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "lldp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "advertiseIntervalInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 300
        },
        "holdTimeInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 60,
          "maximum": 1200
        },
        "managementIPTLVEnabled": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "ledMode": {
      "enum": [
        null,
        "CableModem",
        "AccessPoint",
        "CableModem_AccessPoint",
        "CableModem_AccessPoint_DEFAULT",
        "ActiveSurgeProtector",
        "ActiveSurgeProtector_ModemOnline_DEFAULT",
        "Off"
      ]
    },
    "internalHeaterEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeOutPortEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "usbPowerEnable": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeModeSetting": {
      "enum": [
        null,
        "Auto",
        "_802_3af",
        "_802_3at",
        "_802_3atPlus"
      ]
    },
    "poeTxChain": {
      "description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
      "default": 2,
      "type": [
        "integer",
        "null"
      ]
    },
    "radioBand": {
      "description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
      "enum": [
        null,
        "2.4GHz",
        "5GHz"
      ]
    },
    "externalAntenna24": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "externalAntenna50": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lanPorts": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "portName": {
            "enum": [
              "LAN1",
              "LAN2",
              "LAN3",
              "LAN4",
              "LAN5"
            ]
          },
          "enabled": {
            "type": "boolean"
          },
          "ethPortProfile": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "portName",
          "enabled"
        ]
      }
    }
  }
}
Response  204

Disable Override AP Model

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}

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

Response  204

Modify Radio 2.4G Auto ChannelSelectMode Override

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

Override Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of an AP group.

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

Modify Radio 5G Auto ChannelSelectMode Override

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

Override Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of an AP group.

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

Disable Radio 2.4G Auto ChannelSelectMode Override

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection24

Disable Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC Override of an AP group.

Response  204

Disable Radio 5G Auto ChannelSelectMode Override

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection50

Disable Radio 5G Auto ChannelSelectMode and ChannelFly MTBC Override of an AP group.

Response  204

Disable Channel Evaluation Interval Override

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/channelEvaluationInterval

Disable Channel Evaluation Interval Override of an AP group.

Response  204

Modify AP Usb Software Package

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

Modify AP Usb Software Package of an AP group.

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

Disable AP Usb Software Package

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/usbSoftwarePackage

Disable AP Usb Software Package of an AP group.

URI Parameters
HideShow
applyModel
string (optional) 

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

Response  204

Modify AP Management Vlan

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

Modify AP Management Vlan of an AP group.

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

Disable AP Management Vlan Override

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/apMgmtVlan

Disable AP Management Vlan Override of an AP group.

Response  204

Modify Altitude of ApGroup

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

Use this API command to modify the altitude of AP group.

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

Disable Altitude of ApGroup

DELETE/v5_1/rkszones/{zoneId}/apgroups/{id}/altitude

Use this API command to clear the altitude of AP group.

Response  204

Delete

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

Use this API command to delete an AP group.

Response  204

Access Point Configuration

Retrieve List

GET/v5_1/aps

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

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

zoneId
string (optional) 

filter AP list by zone

domainId
string (optional) 

filter AP list by domain. Default: current logon domain

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "mac": "00:11:22:33:44:55",
      "zoneId": "zoneUUID",
      "apGroupId": "apGroupUUID",
      "name": "apName"
    },
    {
      "mac": "11:22:33:44:55:66",
      "zoneId": "zoneUUID2",
      "apGroupId": "apGroupUUID2",
      "name": "apName2"
    }
  ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "description" : "Total AP count",
            "type" : "integer"
        },
        "hasMore" : {
            "description" : "Indicates whether there are more APs after the list that is currently displayed",
            "type" : "boolean"
        },
        "firstIndex" : {
            "description" : "Index of the first AP returned out of the complete AP list",
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "mac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "MAC address of the AP"
                    },
                    "zoneId" : {
                        "description" : "Identifier of the zone to which the AP belongs",
                        "type" : "string"
                    },
                    "apGroupId" : {
                        "description" : "Identifier of the AP group to which the AP belongs",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the AP",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Retrieve

GET/v5_1/aps/{apMac}

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

Response  200
HideShow
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
    ]
  },
  "wlanGroup24": {
    "id": "wlanGroupUUID",
    "name": "wlanGroupName"
  },
  "wlanGroup50": {
    "id": "wlanGroupUUID",
    "name": "wlanGroupName"
  },
  "network": {
    "ipType": "Static",
    "ip": "1.1.1.1",
    "netmask": "255.255.255.0",
    "gateway": "1.1.1.0",
    "primaryDns": "8.8.8.8",
    "secondaryDns": "8.8.8.9"
  },
  "smartMonitor": {
    "enabled": true,
    "intervalInSec": 10,
    "retryThreshold": 10
  },
  "bonjourGateway": {
    "id": "bonjourGatewayUUID",
    "name": "bonjourGatewayName"
  },
  "specific": {
    "ledStatusEnabled": false,
    "lldp": {
      "enabled": true,
      "advertiseIntervalInSec": 100,
      "holdTimeInSec": 1000,
      "managementIPTLVEnabled": false
    },
    "ledMode": null,
    "internalHeaterEnabled": null,
    "poeOutPortEnabled": null,
    "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
{
    "additionalProperties" : false,
    "properties" : {
        "administrativeState" : {
            "default" : "Unlocked",
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "enum" : [ "Locked", "Unlocked" ]
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            },
            "description" : "GPS Altitude"
        },
        "apGroupId" : {
            "type" : "string"
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            },
            "description" : "ap Management Vlan"
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 5G, auto channel selection mode"
        },
        "bonjourGateway" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Bonjour gateway of the AP."
        },
        "channelEvaluationInterval" : {
            "default" : 600,
            "description" : "channel evaluation Interval of the AP",
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "Client admission control configuration of 2.4GHz radio of the AP."
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "Client admission control configuration of 5GHz radio of the AP."
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the AP"
        },
        "gpsSource" : {
            "description" : "GPS Source of the AP",
            "enum" : [ "GPS", "MANUAL" ]
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the AP"
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the AP. It is a text description to indicate the location of the AP."
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP."
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
                    "description" : "User name of the AP administrator"
                },
                "apLoginPassword" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
                    "description" : "Password of the AP administrator"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ],
            "description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level."
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the AP"
        },
        "mac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
            "description" : "MAC address of the AP"
        },
        "meshOptions" : {
            "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])|(\d+)$"
                    }
                }
            },
            "description" : "mesh options"
        },
        "model" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
            "description" : "Name of the AP"
        },
        "network" : {
            "additionalProperties" : false,
            "properties" : {
                "gateway" : {
                    "type" : "string",
                    "description" : "Gateway of the AP"
                },
                "ip" : {
                    "type" : "string",
                    "description" : "IP address of the AP"
                },
                "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" : [ "Dynamic", "Keep", "Static" ]
                },
                "netmask" : {
                    "type" : "string",
                    "pattern" : "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)",
                    "description" : "Netmask of the AP's subnet"
                },
                "primaryDns" : {
                    "type" : "string",
                    "description" : "Primary DNS server address of the AP"
                },
                "secondaryDns" : {
                    "type" : "string",
                    "description" : "Secondary DNS server address of the AP"
                }
            },
            "type" : "object",
            "description" : "Network settings of the AP."
        },
        "provisionChecklist" : {
            "description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            },
            "description" : "Smart monitor of the AP."
        },
        "specific" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ledStatusEnabled" : {
                    "type" : [ "boolean", "null" ]
                },
                "lldp" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "enabled" : {
                            "type" : "boolean"
                        },
                        "advertiseIntervalInSec" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 1,
                            "maximum" : 300
                        },
                        "holdTimeInSec" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 60,
                            "maximum" : 1200
                        },
                        "managementIPTLVEnabled" : {
                            "type" : [ "boolean", "null" ]
                        }
                    },
                    "required" : [ "enabled" ]
                },
                "ledMode" : {
                    "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
                },
                "internalHeaterEnabled" : {
                    "type" : [ "boolean", "null" ]
                },
                "poeOutPortEnabled" : {
                    "type" : [ "boolean", "null" ]
                },
                "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" ]
                    }
                }
            },
            "description" : "Model specific configuration of the AP"
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Indicates whether syslog is enabled or disabled",
                    "type" : "boolean"
                },
                "address" : {
                    "type" : "string",
                    "description" : "Address of the syslog server. If syslog is enabled, this attribute is required."
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : "514",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                }
            },
            "required" : [ "enabled" ],
            "description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level."
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Venue profile configuration of the AP."
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "description" : "2.4GHz radio configuration of the AP. This configuration will override the radio 2.4GHz configuration at the zone level or AP group level."
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "transmission power"
                },
                "channelWidth" : {
                    "description" : "channel width, 0 mean Auto, 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"
                    }
                }
            },
            "description" : "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level."
        },
        "wlanGroup24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the WLAN group",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the WLAN group",
                    "type" : "string"
                }
            },
            "description" : "WLAN group of 2.4GHz radio. This configuration will override the WLAN group of the 2.4GHz radio at the zone level or AP group level."
        },
        "wlanGroup50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the WLAN group",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the WLAN group",
                    "type" : "string"
                }
            },
            "description" : "WLAN group of 5GHz radio. This configuration will override the WLAN group of the 5GHz radio at the zone level or AP group level."
        },
        "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"
        },
        "zoneId" : {
            "description" : "Identifier of the AP group to which the AP belongs",
            "type" : "string"
        }
    },
    "type" : "object"
}

Retrieve AP Picture

GET/v5_1/aps/{apMac}/picture

Use this API command to retrieve the current AP picture.

Response  200
HideShow
Body
Binary data for the picture

Create

POST/v5_1/aps

Use this API command to create a new access point.

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

Modify Basic

PATCH/v5_1/aps/{apMac}

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

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

Disable Location Override

DELETE/v5_1/aps/{apMac}/location

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

Response  204

Disable Location AdditionalInfo Override

DELETE/v5_1/aps/{apMac}/locationAdditionalInfo

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

Response  204

Modify Login Override

PATCH/v5_1/aps/{apMac}/login

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

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

Disable Login Override

DELETE/v5_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.

Response  204

Modify Syslog Override

PATCH/v5_1/aps/{apMac}/syslog

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

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

Disable Syslog Override

DELETE/v5_1/aps/{apMac}/syslog

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

Response  204

Modify Radio 2.4G Override

PATCH/v5_1/aps/{apMac}/wifi24

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

Request
HideShow
Body
{
  "txPower": "Full",
  "channelWidth": 20,
  "channel": 1,
  "channelRange": [
    1,
    2,
    3
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "txPower": {
      "enum": [
        "Full",
        "-1dB",
        "-2dB",
        "-3dB(1/2)",
        "-4dB",
        "-5dB",
        "-6dB(1/4)",
        "-7dB",
        "-8dB",
        "-9dB(1/8)",
        "-10dB",
        "Min"
      ],
      "description": "Transmission power"
    },
    "channelWidth": {
      "description": "Channel width. Zero (0) means Auto.",
      "enum": [
        0,
        20,
        40
      ]
    },
    "channel": {
      "description": "Channel number",
      "type": "integer"
    },
    "channelRange": {
      "description": "Channel range options",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "description": "2.4GHz radio configuration of the AP. This configuration will override the radio 2.4GHz configuration at the zone level or AP group level."
}
Response  204

Disable Radio 2.4G Override

DELETE/v5_1/aps/{apMac}/wifi24

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

Response  204

Disable Radio 2.4G TxPower Override

DELETE/v5_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.

Response  204

Disable Radio 2.4G ChannelWidth Override

DELETE/v5_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.

Response  204

Disable Radio 2.4G Channel Override

DELETE/v5_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.

Response  204

Disable Radio 2.4G ChannelRange Override

DELETE/v5_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.

Response  204

Modify Radio 5G Override

PATCH/v5_1/aps/{apMac}/wifi50

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

Request
HideShow
Body
{
  "txPower": "Full",
  "channelWidth": 20,
  "channel": 52,
  "channelRange": [
    52,
    56,
    60
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "txPower": {
      "enum": [
        "Full",
        "-1dB",
        "-2dB",
        "-3dB(1/2)",
        "-4dB",
        "-5dB",
        "-6dB(1/4)",
        "-7dB",
        "-8dB",
        "-9dB(1/8)",
        "-10dB",
        "Min"
      ],
      "description": "transmission power"
    },
    "channelWidth": {
      "description": "channel width, 0 mean Auto, 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"
      }
    }
  },
  "description": "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level."
}
Response  204

Disable Radio 5G Override

DELETE/v5_1/aps/{apMac}/wifi50

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

Response  204

Disable Radio 5G TxPower Override

DELETE/v5_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.

Response  204

Disable Radio 5G ChannelWidth Override

DELETE/v5_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.

Response  204

Disable Radio 5G Channel Override

DELETE/v5_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.

Response  204

Disable Radio 5G ChannelRange Override

DELETE/v5_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.

Response  204

Modify WLAN Group 2.4G Override

PATCH/v5_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.

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

Disable WLAN Group 2.4G Override

DELETE/v5_1/aps/{apMac}/wlanGroup24

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

Response  204

Modify WLAN Group 5G Override

PATCH/v5_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.

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

Disable WLAN group 5G Override

DELETE/v5_1/aps/{apMac}/wlanGroup50

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

Response  204

Modify Network Settings

PATCH/v5_1/aps/{apMac}/network

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

Request
HideShow
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
{
  "additionalProperties": false,
  "properties": {
    "gateway": {
      "type": "string",
      "description": "Gateway of the AP"
    },
    "ip": {
      "type": "string",
      "description": "IP address of the AP"
    },
    "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": [
        "Dynamic",
        "Keep",
        "Static"
      ]
    },
    "netmask": {
      "type": "string",
      "pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)",
      "description": "Netmask of the AP's subnet"
    },
    "primaryDns": {
      "type": "string",
      "description": "Primary DNS server address of the AP"
    },
    "secondaryDns": {
      "type": "string",
      "description": "Secondary DNS server address of the AP"
    }
  },
  "type": "object",
  "description": "Network settings of the AP."
}
Response  204

Modify Smart Monitor

PATCH/v5_1/aps/{apMac}/smartMonitor

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

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

Disable Smart Monitor Override

DELETE/v5_1/aps/{apMac}/smartMonitor

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

Response  204

Modify Bonjour Gateway

PATCH/v5_1/aps/{apMac}/bonjourGateway

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

Request
HideShow
Body
{
  "id": "bonjourGatewayUUID",
  "name": "bonjourGatewayName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Bonjour gateway of the AP."
}
Response  204

Disable Bonjour Gateway Override

DELETE/v5_1/aps/{apMac}/bonjourGateway

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

Response  204

Modify Client Admission Control 2.4G

PATCH/v5_1/aps/{apMac}/clientAdmissionControl24

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

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

Disable Client Admission Control 2.4G Override

DELETE/v5_1/aps/{apMac}/clientAdmissionControl24

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

Response  204

Modify Client Admission Control 5G

PATCH/v5_1/aps/{apMac}/clientAdmissionControl50

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

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

Disable Client Admission Control 5G Override

DELETE/v5_1/aps/{apMac}/clientAdmissionControl50

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

Response  204

Modify Venue Profile

PATCH/v5_1/aps/{apMac}/venueProfile

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

Request
HideShow
Body
{
  "id": "venueProfileId",
  "name": "venueProfileName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Venue profile configuration of the AP."
}
Response  204

Disable Venue Profile Override

DELETE/v5_1/aps/{apMac}/venueProfile

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

Response  204

Modify Specific

PUT/v5_1/aps/{apMac}/specific

Use this API command to modify specific configuration.

Request
HideShow
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"
        },
        "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"
        ]
      }
    }
  }
}
Response  204

Disable Specific Override

DELETE/v5_1/aps/{apMac}/specific

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

Response  204

Upload AP Picture

POST/v5_1/aps/{apMac}/picture

Use this API command to upload a new AP picture.

Request
HideShow
Body
Binary data for the picture
Response  204

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.

Request
HideShow
Body
Binary data for the picture
Response  204

Delete AP Picture

DELETE/v5_1/aps/{apMac}/picture

Use this API command to delete an AP picture.

Response  204

Modify AP Usb Software Package

PATCH/v5_1/aps/{apMac}/usbSoftwarePackage

Modify AP Usb Software Package of an access point.

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

Disable AP Usb Software Package

DELETE/v5_1/aps/{apMac}/usbSoftwarePackage

Disable AP level Usb Software Package. The access point will take its group’s configuration or zone’s configuration.

Response  204

Disable AP Channel Evaluation Interval

DELETE/v5_1/aps/{apMac}/channelEvaluationInterval

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

Response  204

Modify Radio 2.4G Auto ChannelSelectMode Override

PATCH/v5_1/aps/{apMac}/autoChannelSelection24

Override Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of an AP.

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

Disable Radio 2.4G Auto channel selection

DELETE/v5_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.

Response  204

Modify Radio 5G Auto ChannelSelectMode Override

PATCH/v5_1/aps/{apMac}/autoChannelSelection50

Override Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of an AP.

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

Disable Radio 5G Auto channel selection

DELETE/v5_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.

Response  204

Modify AP Management Vlan

PATCH/v5_1/aps/{apMac}/apMgmtVlan

Modify AP Management Vlan of an AP.

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

Disable AP Management Vlan Override

DELETE/v5_1/aps/{apMac}/apMgmtVlan

Disable AP Management Vlan Override of an AP.

Response  204

Modify Altitude Override

PATCH/v5_1/aps/{apMac}/altitude

Use this API command to modify the altitude of an AP.

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

Disable Altitude Override

DELETE/v5_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.

Response  204

Modify Mesh Options

PATCH/v5_1/aps/{apMac}/meshOptions

Use this API command to modify mesh options of an AP.

Request
HideShow
Body
{
  "meshMode": "MESH_AP",
  "uplinkSelection": "MANUAL",
  "meshUplinkEntryList": [
    "6C:AA:B3:26:6C:30"
  ]
}
Schema
{
    "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])|(\d+)$"
            }
        }
    },
    "description" : "mesh options"
}
Response  204

Disable Mesh Options

DELETE/v5_1/aps/{apMac}/meshOptions

Use this API command to disable mesh options.

Response  204

Disable AP Management GPS Cooordinates

DELETE/v5_1/aps/{apMac}/gpsCoordinates

Disable AP Management GPS Cooordinates of an AP.

Response  204

Delete

DELETE/v5_1/aps/{apMac}

Use this API command to delete an access point.

Response  204

Reboot

PUT/v5_1/aps/{apMac}/reboot

reboot an access point.

Response  204

Download AP support log

GET/v5_1/aps/{apMac}/supportLog

Use this API command to download AP support log.

Response  200

Access Point Operational

Retrieve Operational Information

GET/v5_1/aps/{apMac}/operational/summary

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

Response  200
HideShow
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
{
    "additionalProperties" : false,
    "properties" : {
        "administrativeState" : {
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "enum" : [ "Locked", "Unlocked" ]
        },
        "apGroupId" : {
            "description" : "Identifier of the AP group to which the AP belongs",
            "type" : "string"
        },
        "approvedTime" : {
            "description" : "Timestamp when the AP was approved by the controller",
            "type" : "integer"
        },
        "clientCount" : {
            "description" : "Number of clients on the AP",
            "type" : "integer"
        },
        "configState" : {
            "description" : "State of the AP configuration.",
            "enum" : [ "completed", "configApplied", "configFailed", "fwApplied", "fwDownloaded", "fwFailed", "newConfig" ]
        },
        "connectionState" : {
            "description" : "Connection state of the AP (value: 'Discovery','Connect','Rebooting','Disconnect','Provisioned')",
            "type" : "string"
        },
        "countryCode" : {
            "description" : "Country code of the AP",
            "type" : "string"
        },
        "cpId" : {
            "description" : "Identifier of the control plane to which the AP is currently connected",
            "type" : "string"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the AP"
        },
        "dpId" : {
            "description" : "Identifier of the data plane to which the AP is currently connected",
            "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"
        },
        "ip" : {
            "description" : "IP address of the AP",
            "type" : "string"
        },
        "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" : [ "Dynamic", "Keep", "Static" ]
        },
        "isCriticalAP" : {
            "description" : "Indicates critical APs. Critical AP are APs that were tagged by the controller based on predefined rules.",
            "type" : "boolean"
        },
        "lastSeenTime" : {
            "description" : "Timestamp of the last successful communication with the AP",
            "type" : "integer"
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the AP"
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the AP. This is a text description that indicates the location of the AP."
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the AP"
        },
        "mac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
            "description" : "MAC address of the AP"
        },
        "managementVlan" : {
            "description" : "Management vlan on the AP",
            "type" : "integer"
        },
        "meshHop" : {
            "description" : "Number of mesh hops of the AP. This is only applicable to mesh APs.",
            "type" : "integer"
        },
        "meshRole" : {
            "description" : "Mesh role of the AP",
            "enum" : [ "Disabled", "Down", "Map", "Root", "Undefined", "eMap" ]
        },
        "model" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
            "description" : "Name of the AP"
        },
        "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"
        },
        "registrationState" : {
            "description" : "Registration state of the AP",
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "uptime" : {
            "description" : "Uptime of the AP since it was last rebooted (unit:second)",
            "type" : "integer"
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
            "description" : "Firmware version of the AP"
        },
        "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"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the AP belongs",
            "type" : "string"
        }
    },
    "type" : "object"
}

Retrieve Alarm Summary

GET/v5_1/aps/{apMac}/operational/alarmSummary

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

Response  200
HideShow
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/v5_1/aps/{apMac}/operational/eventSummary

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

Response  200
HideShow
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/v5_1/aps/{apMac}/operational/alarms

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

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

severity
string (optional) 

filter by severity

category
string (optional) 

filter by category

code
number (optional) 

filter by alarm code

startTime
string (optional) 

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

endTime
string (optional) 

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

status
string (optional) 

filter by alarm status

Response  200
HideShow
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" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "Identifier of the alarm"
                    },
                    "time" : {
                        "description" : "Time of the alarm",
                        "type" : "string"
                    },
                    "code" : {
                        "description" : "Alarm code",
                        "type" : "string"
                    },
                    "category" : {
                        "description" : "Alarm category",
                        "type" : "string"
                    },
                    "type" : {
                        "description" : "Alarm type",
                        "type" : "string"
                    },
                    "severity" : {
                        "description" : "Alarm severity",
                        "enum" : [ "Critical", "Major", "Minor", "Warning", "Informational" ]
                    },
                    "description" : {
                        "description" : "Alarm description",
                        "type" : "string"
                    },
                    "status" : {
                        "description" : "Alarm status",
                        "enum" : [ "Outstanding", "Acknowledged", "Cleared" ]
                    },
                    "clearedTime" : {
                        "description" : "Time that alarm was cleared",
                        "type" : "integer"
                    },
                    "acknowledgedTime" : {
                        "description" : "Time the alarm was acknowledged",
                        "type" : "integer"
                    }
                }
            }
        }
    }
}

Retrieve Event List

GET/v5_1/aps/{apMac}/operational/events

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

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

type
string (optional) 

Query type, valid value is AND or OR. Default: AND

value
string (optional) 

Vague value to search. Could be a list of value, like value=ABC&value=CD in the parameter.

order
string (optional) 

Value of order parameter.

direction
string (optional) 

Direction of order parameter, valid value id ASC or DESC. Default: DESC

fixSearch
string (optional) Example: key1=value1&key2=value2

fixSearch is not mean real query key. It is for other fix search parameters to search, like key1=value1&key2=value2

Response  200
HideShow
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" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "Identifier of the event"
                    },
                    "time" : {
                        "description" : "Time of the event",
                        "type" : "string"
                    },
                    "code" : {
                        "description" : "Event code",
                        "type" : "string"
                    },
                    "category" : {
                        "description" : "Event category",
                        "type" : "string"
                    },
                    "type" : {
                        "description" : "Event type",
                        "type" : "string"
                    },
                    "severity" : {
                        "description" : "Event severity",
                        "enum" : [ "Critical", "Major", "Minor", "Warning", "Informational", "Debug" ]
                    },
                    "description" : {
                        "description" : "Event description",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Retrieve Mesh Neighbor AP List

GET/v5_1/aps/{apMac}/operational/neighbor

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

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "mac": "8C:0C:90:2B:8B:90",
      "model": "ZF7372",
      "name": "RuckusAP",
      "version": "3.1.0.0.157",
      "ip": "10.2.6.239",
      "externalIp": "10.2.6.239",
      "externalPort": "58788",
      "connectionState": "Connect",
      "channel": "40 (11a/n)",
      "signal": "119%",
      "zoneName": "neilMeshZone"
    }
  ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "description" : "Total mesh neighbor APs count",
            "type" : "integer"
        },
        "hasMore" : {
            "description" : "Indicator of whether there are more Mesh Neighbor APs after the current displayed list",
            "type" : "boolean"
        },
        "firstIndex" : {
            "description" : "Index of the first Mesh Neighbor AP returned out of the complete Mesh Neighbor AP list",
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "mac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "MAC address of the mesh neighbor AP"
                    },
                    "name" : {
                        "description" : "Name of the mesh neighbor AP",
                        "type" : "string"
                    },
                    "zoneName" : {
                        "description" : "Name of the zone which the mesh neighbor AP belongs to",
                        "type" : "string"
                    },
                    "ip" : {
                        "description" : "IP address of the mesh neighbor AP",
                        "type" : "string"
                    },
                    "externalIp" : {
                        "description" : "External IP of the mesh neighbor AP ",
                        "type" : "string"
                    },
                    "externalPort" : {
                        "description" : "External port of the mesh neighbor AP ",
                        "type" : "string"
                    },
                    "model" : {
                        "description" : "Model of the mesh neighbor AP ",
                        "type" : "string"
                    },
                    "version" : {
                        "description" : "Firmware version of the mesh neighbor AP ",
                        "type" : "string"
                    },
                    "channel" : {
                        "description" : "Channel of the mesh neighbor AP ",
                        "type" : "string"
                    },
                    "signal" : {
                        "description" : "Signal of the mesh neighbor AP ",
                        "type" : "string"
                    },
                    "connectionState" : {
                        "description" : "Connection state of the mesh neighbor AP ",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

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”.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

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.

Response  200
HideShow
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" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "AP MAC of the rogue AP"
                    },
                    "apName" : {
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 64,
                        "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
                        "description" : "Name of the rogue AP"
                    },
                    "rogueMac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "Rogue MAC of the rogue AP"
                    },
                    "rogueAPMac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "Rogue AP MAC of the rogue AP"
                    },
                    "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/v5_1/rkszones/{zoneId}/wlangroups

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

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the WLAN group"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the WLAN group"
          },
          "members": {
            "description": "Members of the WLAN group",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "id": {
                  "description": "Identifier of the WLAN",
                  "type": "string"
                },
                "accessVlan": {
                  "description": "Access VLAN",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 4094
                },
                "vlanPooling": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "additionalProperties": false,
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  },
                  "description": "Vlan pooling"
                },
                "nasId": {
                  "description": "NAS-ID",
                  "type": "string",
                  "maxLength": 63,
                  "pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
                }
              },
              "required": [
                "id"
              ]
            }
          },
          "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/v5_1/rkszones/{zoneId}/wlangroups/{id}

Use this API command to retrieve the WLAN group.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the WLAN group"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the WLAN group"
    },
    "members": {
      "description": "Members of the WLAN group",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the WLAN",
            "type": "string"
          },
          "accessVlan": {
            "description": "Access VLAN",
            "type": "integer",
            "minimum": 1,
            "maximum": 4094
          },
          "vlanPooling": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "description": "Vlan pooling"
          },
          "nasId": {
            "description": "NAS-ID",
            "type": "string",
            "maxLength": 63,
            "pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
          }
        },
        "required": [
          "id"
        ]
      }
    },
    "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/v5_1/rkszones/{zoneId}/wlangroups

Use this API command to create a new WLAN group.

Request
HideShow
Body
{
  "name": "wlanGroupName",
  "description": "wlanGroupDescription"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the WLAN group"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the WLAN group"
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "wlanGroupUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the WLAN group",
      "type": "string"
    }
  }
}

Modify Basic

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

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

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

Add Member

POST/v5_1/rkszones/{zoneId}/wlangroups/{id}/members

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

Request
HideShow
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": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "Vlan pooling"
    },
    "nasId": {
      "description": "NAS-ID",
      "type": "string",
      "maxLength": 63,
      "pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
    }
  },
  "required": [
    "id"
  ]
}
Response  201

Modify Member

PATCH/v5_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}

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

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

Modify Member VLAN Pooling

PATCH/v5_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/vlanPooling

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

Request
HideShow
Body
{
  "id": "a61997e0-699b-11e4-b9bb-08002716c79f",
  "name": "zoneVlanPooling"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Vlan pooling"
}
Response  204

Disable Member VLAN Override

DELETE/v5_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/vlanOverride

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

Response  204

Disable Member NAS Override

DELETE/v5_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/nasId

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

Response  204

Remove Member

DELETE/v5_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}

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

Response  204

Delete

DELETE/v5_1/rkszones/{zoneId}/wlangroups/{id}

Use this API command to delete a WLAN group.

Response  204

WLAN

Retrieve List

GET/v5_1/rkszones/{zoneId}/wlans

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

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "1028",
      "mvnoId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "wlan2",
      "ssid": "wlan2"
    },
    {
      "id": "1027",
      "mvnoId": "bbbbbbbb-bbbb-cccc-dddd-eeeeeeeeeeee",
      "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/v5_1/rkszones/{zoneId}/wlans/{id}

Use this API command to retrieve a WLAN.

Response  200
HideShow
Body
{
  "id": "1027",
  "zoneId": "21a18b1c-e260-48c8-866c-69e66c81368e",
  "name": "wlan1",
  "ssid": "wlan1",
  "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,
  "vlan": {
    "accessVlan": null,
    "aaaVlanOverride": false,
    "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"
  },
  "advancedOptions": {
    "uplinkRateLimiting": "Disable",
    "downlinkRateLimiting": "Disable",
    "clientIsoationEnabled": 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,
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "bandBalancing": "UseZoneSetting"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "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" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : "string"
        },
        "type" : {
            "description" : "Type of the WLAN",
            "enum" : [ "Standard_Open", "Standard_8021X", "Standard_Mac", "Hotspot", "Hotspot_MacByPass", "Guest", "WebAuth", "Hotspot20", "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"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable",
            "type" : "boolean"
        },
        "encryption" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "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" ],
            "description" : "Encryption of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Autentication of the WLAN"
        },
        "operatorRealm" : {
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true "
        },
        "macAuth" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "enum" : [ "Default", "802.1X", "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})$"
                }
            },
            "description" : "MAC authentication of the WLAN"
        },
        "accountingServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Accounting of the WLAN"
        },
        "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" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs."
        },
        "hotspot20Profile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
        },
        "defaultUserTrafficProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "User traffic profile of the WLAN"
        },
        "coreTunnelProfile" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object",
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
        },
        "vlan" : {
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "vlanPooling" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Vlan pooling"
                }
            },
            "type" : "object",
            "description" : "VLAN (access and/or core) of the WLAN."
        },
        "l2ACL" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Layer 2 ACL of the WLAN"
        },
        "devicePolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Device policy of the WLAN"
        },
        "radiusOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 63,
                    "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                }
            },
            "type" : "object",
            "description" : "RADIUS options of the WLAN."
        },
        "schedule" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ],
            "description" : "Schedule of the WLAN."
        },
        "advancedOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "description" : "BSS minimum rate (mbps)"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Indicates wireless client isolation whitelist"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                    "type" : "boolean"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "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 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "description" : "Management TX rate (mbps)"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether OKC support is enabled or disabled",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether PKM caching support is enabled or disabled",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211dEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                }
            },
            "type" : "object",
            "description" : "Advanced settings for the WLAN."
        },
        "diffServProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DiffServ profile of the WLAN"
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "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" ]
                }
            },
            "description" : "DPSK Setting"
        },
        "dnsServerProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DNS server profile of the WLAN"
        },
        "bssid" : {
            "description" : "BSSID of the WLAN",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        }
    }
}

Create - Standard Open

POST/v5_1/rkszones/{zoneId}/wlans

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

Request
HideShow
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"
  },
  "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" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "bypassCNA" : {
            "description" : "By pass Capitive Network Assitance",
            "type" : [ "boolean", "null" ]
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT 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" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object",
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
        },
        "macAuth" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "enum" : [ "Default", "802.1X", "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})$"
                }
            },
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN."
        },
        "encryption" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "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" ],
            "description" : "Encryption of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN"
        },
        "operatorRealm" : {
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true "
        },
        "accountingServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Accounting of the WLAN"
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs."
        },
        "hotspot20Profile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
        },
        "defaultUserTrafficProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "User traffic profile of the WLAN"
        },
        "schedule" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ],
            "description" : "Schedule of the WLAN"
        },
        "vlan" : {
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "vlanPooling" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Vlan pooling"
                }
            },
            "type" : "object",
            "description" : "VLAN (access and/or core) of the WLAN."
        },
        "l2ACL" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Layer 2 ACL of the WLAN"
        },
        "devicePolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Device policy of the WLAN"
        },
        "radiusOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 63,
                    "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                }
            },
            "type" : "object",
            "description" : "RADIUS options of the WLAN"
        },
        "advancedOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "description" : "BSS minimum rate (mbps)"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Indicates wireless client isolation whitelist"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                    "type" : "boolean"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "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 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "description" : "Management TX rate (mbps)"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether OKC support is enabled or disabled",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether PKM caching support is enabled or disabled",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211dEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                }
            },
            "type" : "object",
            "description" : "Advanced settings for the WLAN."
        },
        "diffServProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DiffServ profile of the WLAN"
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "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" ]
                }
            },
            "description" : "DPSK Setting"
        },
        "externalDpsk" : {
            "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" ],
            "description" : "External DPSK Enabled"
        },
        "dnsServerProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DNS server profile of the WLAN"
        }
    },
    "required" : [ "name", "ssid" ]
}
Response  201
HideShow
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, and no longer be supported.For the alternative URI, please refer to the “Create - 802.1X”

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": false,
    "id": "authServiceUUID",
    "name": "authServiceName"
  },
  "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"
  },
  "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": {
    "multiSample": [
      {
        "sampleDescription": "Enable external DPSK with encryption WPA2 and radius authentication service of proxy mode",
        "sampleJson": {
          "enabled": true,
          "encryption": {
            "method": "WPA2",
            "algorithm": "AES"
          },
          "authService": {
            "id": "authServiceUUID"
          }
        }
      },
      {
        "sampleDescription": "Disable external DPSK with encryption None",
        "sampleJson": {
          "enabled": false,
          "encryption": {
            "method": "None"
          }
        }
      }
    ]
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "bypassCNA" : {
            "description" : "By pass Capitive Network Assitance",
            "type" : [ "boolean", "null" ]
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT 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" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object",
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
        },
        "macAuth" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "enum" : [ "Default", "802.1X", "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})$"
                }
            },
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN."
        },
        "encryption" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "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" ],
            "description" : "Encryption of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required."
        },
        "operatorRealm" : {
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true "
        },
        "accountingServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Accounting of the WLAN"
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs."
        },
        "hotspot20Profile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
        },
        "defaultUserTrafficProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "User traffic profile of the WLAN"
        },
        "schedule" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ],
            "description" : "Schedule of the WLAN"
        },
        "vlan" : {
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "vlanPooling" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Vlan pooling"
                }
            },
            "type" : "object",
            "description" : "VLAN (access and/or core) of the WLAN."
        },
        "l2ACL" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Layer 2 ACL of the WLAN"
        },
        "devicePolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Device policy of the WLAN"
        },
        "radiusOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 63,
                    "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                }
            },
            "type" : "object",
            "description" : "RADIUS options of the WLAN"
        },
        "advancedOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "description" : "BSS minimum rate (mbps)"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Indicates wireless client isolation whitelist"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                    "type" : "boolean"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "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 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "description" : "Management TX rate (mbps)"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether OKC support is enabled or disabled",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether PKM caching support is enabled or disabled",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211dEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                }
            },
            "type" : "object",
            "description" : "Advanced settings for the WLAN."
        },
        "diffServProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DiffServ profile of the WLAN"
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "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" ]
                }
            },
            "description" : "DPSK Setting"
        },
        "externalDpsk" : {
            "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" ],
            "description" : "External DPSK Enabled"
        },
        "dnsServerProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DNS server profile of the WLAN"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - 802.1X

POST/v5_1/rkszones/{zoneId}/wlans/standard8021X

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

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": false,
    "id": "authServiceUUID",
    "name": "authServiceName"
  },
  "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"
  },
  "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": {
    "multiSample": [
      {
        "sampleDescription": "Enable external DPSK with encryption WPA2 and radius authentication service of proxy mode",
        "sampleJson": {
          "enabled": true,
          "encryption": {
            "method": "WPA2",
            "algorithm": "AES"
          },
          "authService": {
            "id": "authServiceUUID"
          }
        }
      },
      {
        "sampleDescription": "Disable external DPSK with encryption None",
        "sampleJson": {
          "enabled": false,
          "encryption": {
            "method": "None"
          }
        }
      }
    ]
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "bypassCNA" : {
            "description" : "By pass Capitive Network Assitance",
            "type" : [ "boolean", "null" ]
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT 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" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object",
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
        },
        "macAuth" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "enum" : [ "Default", "802.1X", "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})$"
                }
            },
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN."
        },
        "encryption" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "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" ],
            "description" : "Encryption of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required."
        },
        "operatorRealm" : {
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true "
        },
        "accountingServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Accounting of the WLAN"
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs."
        },
        "hotspot20Profile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
        },
        "defaultUserTrafficProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "User traffic profile of the WLAN"
        },
        "schedule" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ],
            "description" : "Schedule of the WLAN"
        },
        "vlan" : {
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "vlanPooling" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Vlan pooling"
                }
            },
            "type" : "object",
            "description" : "VLAN (access and/or core) of the WLAN."
        },
        "l2ACL" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Layer 2 ACL of the WLAN"
        },
        "devicePolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Device policy of the WLAN"
        },
        "radiusOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 63,
                    "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                }
            },
            "type" : "object",
            "description" : "RADIUS options of the WLAN"
        },
        "advancedOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "description" : "BSS minimum rate (mbps)"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Indicates wireless client isolation whitelist"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                    "type" : "boolean"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "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 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "description" : "Management TX rate (mbps)"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether OKC support is enabled or disabled",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether PKM caching support is enabled or disabled",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211dEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                }
            },
            "type" : "object",
            "description" : "Advanced settings for the WLAN."
        },
        "diffServProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DiffServ profile of the WLAN"
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "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" ]
                }
            },
            "description" : "DPSK Setting"
        },
        "externalDpsk" : {
            "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" ],
            "description" : "External DPSK Enabled"
        },
        "dnsServerProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DNS server profile of the WLAN"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - MAC Auth

POST/v5_1/rkszones/{zoneId}/wlans/standardmac

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

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": false,
    "id": "authServiceUUID",
    "name": "authServiceName"
  },
  "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"
  },
  "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": {
    "multiSample": [
      {
        "sampleDescription": "Enable external DPSK with encryption WPA2 and radius authentication service of proxy mode",
        "sampleJson": {
          "enabled": true,
          "encryption": {
            "method": "WPA2",
            "algorithm": "AES"
          },
          "authService": {
            "id": "authServiceUUID"
          }
        }
      },
      {
        "sampleDescription": "Disable external DPSK with encryption None",
        "sampleJson": {
          "enabled": false,
          "encryption": {
            "method": "None"
          }
        }
      }
    ]
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "bypassCNA" : {
            "description" : "By pass Capitive Network Assitance",
            "type" : [ "boolean", "null" ]
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT 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" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object",
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
        },
        "macAuth" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "enum" : [ "Default", "802.1X", "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})$"
                }
            },
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN."
        },
        "encryption" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "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" ],
            "description" : "Encryption of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required."
        },
        "operatorRealm" : {
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true "
        },
        "accountingServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Accounting of the WLAN"
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs."
        },
        "hotspot20Profile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
        },
        "defaultUserTrafficProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "User traffic profile of the WLAN"
        },
        "schedule" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ],
            "description" : "Schedule of the WLAN"
        },
        "vlan" : {
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "vlanPooling" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Vlan pooling"
                }
            },
            "type" : "object",
            "description" : "VLAN (access and/or core) of the WLAN."
        },
        "l2ACL" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Layer 2 ACL of the WLAN"
        },
        "devicePolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Device policy of the WLAN"
        },
        "radiusOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 63,
                    "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                }
            },
            "type" : "object",
            "description" : "RADIUS options of the WLAN"
        },
        "advancedOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "description" : "BSS minimum rate (mbps)"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Indicates wireless client isolation whitelist"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                    "type" : "boolean"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "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 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "description" : "Management TX rate (mbps)"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether OKC support is enabled or disabled",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether PKM caching support is enabled or disabled",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211dEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                }
            },
            "type" : "object",
            "description" : "Advanced settings for the WLAN."
        },
        "diffServProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DiffServ profile of the WLAN"
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "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" ]
                }
            },
            "description" : "DPSK Setting"
        },
        "externalDpsk" : {
            "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" ],
            "description" : "External DPSK Enabled"
        },
        "dnsServerProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DNS server profile of the WLAN"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot

POST/v5_1/rkszones/{zoneId}/wlans/wispr

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

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": false,
    "id": "authServiceUUID",
    "name": "authServiceName"
  },
  "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": {
    "multiSample": [
      {
        "sampleDescription": "Enable external DPSK with encryption WPA2 and radius authentication service of proxy mode",
        "sampleJson": {
          "enabled": true,
          "encryption": {
            "method": "WPA2",
            "algorithm": "AES"
          },
          "authService": {
            "id": "authServiceUUID"
          }
        }
      },
      {
        "sampleDescription": "Disable external DPSK with encryption None",
        "sampleJson": {
          "enabled": false,
          "encryption": {
            "method": "None"
          }
        }
      }
    ]
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "bypassCNA" : {
            "description" : "By pass Capitive Network Assitance",
            "type" : [ "boolean", "null" ]
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT 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" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object",
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
        },
        "macAuth" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "enum" : [ "Default", "802.1X", "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})$"
                }
            },
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN."
        },
        "encryption" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "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" ],
            "description" : "Encryption of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required."
        },
        "operatorRealm" : {
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true "
        },
        "accountingServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Accounting of the WLAN"
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required."
        },
        "hotspot20Profile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
        },
        "defaultUserTrafficProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "User traffic profile of the WLAN"
        },
        "schedule" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ],
            "description" : "Schedule of the WLAN"
        },
        "vlan" : {
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "vlanPooling" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Vlan pooling"
                }
            },
            "type" : "object",
            "description" : "VLAN (access and/or core) of the WLAN."
        },
        "l2ACL" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Layer 2 ACL of the WLAN"
        },
        "devicePolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Device policy of the WLAN"
        },
        "radiusOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 63,
                    "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                }
            },
            "type" : "object",
            "description" : "RADIUS options of the WLAN"
        },
        "advancedOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "description" : "BSS minimum rate (mbps)"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Indicates wireless client isolation whitelist"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                    "type" : "boolean"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "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 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "description" : "Management TX rate (mbps)"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether OKC support is enabled or disabled",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether PKM caching support is enabled or disabled",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211dEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                }
            },
            "type" : "object",
            "description" : "Advanced settings for the WLAN."
        },
        "diffServProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DiffServ profile of the WLAN"
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "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" ]
                }
            },
            "description" : "DPSK Setting"
        },
        "externalDpsk" : {
            "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" ],
            "description" : "External DPSK Enabled"
        },
        "dnsServerProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DNS server profile of the WLAN"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot + MAC bypass

POST/v5_1/rkszones/{zoneId}/wlans/wisprmac

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

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": false,
    "id": "authServiceUUID",
    "name": "authServiceName"
  },
  "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"
  },
  "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": {
    "multiSample": [
      {
        "sampleDescription": "Enable external DPSK with encryption WPA2 and radius authentication service of proxy mode",
        "sampleJson": {
          "enabled": true,
          "encryption": {
            "method": "WPA2",
            "algorithm": "AES"
          },
          "authService": {
            "id": "authServiceUUID"
          }
        }
      },
      {
        "sampleDescription": "Disable external DPSK with encryption None",
        "sampleJson": {
          "enabled": false,
          "encryption": {
            "method": "None"
          }
        }
      }
    ]
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "bypassCNA" : {
            "description" : "By pass Capitive Network Assitance",
            "type" : [ "boolean", "null" ]
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT 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" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object",
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
        },
        "macAuth" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "enum" : [ "Default", "802.1X", "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})$"
                }
            },
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN."
        },
        "encryption" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "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" ],
            "description" : "Encryption of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required."
        },
        "operatorRealm" : {
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true "
        },
        "accountingServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Accounting of the WLAN"
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required."
        },
        "hotspot20Profile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
        },
        "defaultUserTrafficProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "User traffic profile of the WLAN"
        },
        "schedule" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ],
            "description" : "Schedule of the WLAN"
        },
        "vlan" : {
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "vlanPooling" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Vlan pooling"
                }
            },
            "type" : "object",
            "description" : "VLAN (access and/or core) of the WLAN."
        },
        "l2ACL" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Layer 2 ACL of the WLAN"
        },
        "devicePolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Device policy of the WLAN"
        },
        "radiusOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 63,
                    "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                }
            },
            "type" : "object",
            "description" : "RADIUS options of the WLAN"
        },
        "advancedOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "description" : "BSS minimum rate (mbps)"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Indicates wireless client isolation whitelist"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                    "type" : "boolean"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "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 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "description" : "Management TX rate (mbps)"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether OKC support is enabled or disabled",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether PKM caching support is enabled or disabled",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211dEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                }
            },
            "type" : "object",
            "description" : "Advanced settings for the WLAN."
        },
        "diffServProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DiffServ profile of the WLAN"
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "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" ]
                }
            },
            "description" : "DPSK Setting"
        },
        "externalDpsk" : {
            "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" ],
            "description" : "External DPSK Enabled"
        },
        "dnsServerProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DNS server profile of the WLAN"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Guest Access

POST/v5_1/rkszones/{zoneId}/wlans/guest

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

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": true,
    "id": "authServiceUUID",
    "name": "authServiceName"
  },
  "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"
  },
  "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": {
    "multiSample": [
      {
        "sampleDescription": "Enable external DPSK with encryption WPA2 and radius authentication service of proxy mode",
        "sampleJson": {
          "enabled": true,
          "encryption": {
            "method": "WPA2",
            "algorithm": "AES"
          },
          "authService": {
            "id": "authServiceUUID"
          }
        }
      },
      {
        "sampleDescription": "Disable external DPSK with encryption None",
        "sampleJson": {
          "enabled": false,
          "encryption": {
            "method": "None"
          }
        }
      }
    ]
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "bypassCNA" : {
            "description" : "By pass Capitive Network Assitance",
            "type" : [ "boolean", "null" ]
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT 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" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object",
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
        },
        "macAuth" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "enum" : [ "Default", "802.1X", "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})$"
                }
            },
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN."
        },
        "encryption" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "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" ],
            "description" : "Encryption of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN. Guest WLANs only accept two names: Local DB and Always Accept."
        },
        "operatorRealm" : {
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true "
        },
        "accountingServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Accounting of the WLAN"
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Guest portal service of the WLAN. The ID or name of the guest portal services within the zone is required."
        },
        "hotspot20Profile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
        },
        "defaultUserTrafficProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "User traffic profile of the WLAN"
        },
        "schedule" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ],
            "description" : "Schedule of the WLAN"
        },
        "vlan" : {
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "vlanPooling" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Vlan pooling"
                }
            },
            "type" : "object",
            "description" : "VLAN (access and/or core) of the WLAN."
        },
        "l2ACL" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Layer 2 ACL of the WLAN"
        },
        "devicePolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Device policy of the WLAN"
        },
        "radiusOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 63,
                    "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                }
            },
            "type" : "object",
            "description" : "RADIUS options of the WLAN"
        },
        "advancedOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "description" : "BSS minimum rate (mbps)"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Indicates wireless client isolation whitelist"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                    "type" : "boolean"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "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 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "description" : "Management TX rate (mbps)"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether OKC support is enabled or disabled",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether PKM caching support is enabled or disabled",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211dEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                }
            },
            "type" : "object",
            "description" : "Advanced settings for the WLAN."
        },
        "diffServProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DiffServ profile of the WLAN"
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "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" ]
                }
            },
            "description" : "DPSK Setting"
        },
        "externalDpsk" : {
            "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" ],
            "description" : "External DPSK Enabled"
        },
        "dnsServerProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DNS server profile of the WLAN"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Web Auth

POST/v5_1/rkszones/{zoneId}/wlans/webauth

Use this API command to creates new web authentication WLAN.

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": false,
    "id": "authServiceUUID",
    "name": "authServiceName"
  },
  "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"
  },
  "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": {
    "multiSample": [
      {
        "sampleDescription": "Enable external DPSK with encryption WPA2 and radius authentication service of proxy mode",
        "sampleJson": {
          "enabled": true,
          "encryption": {
            "method": "WPA2",
            "algorithm": "AES"
          },
          "authService": {
            "id": "authServiceUUID"
          }
        }
      },
      {
        "sampleDescription": "Disable external DPSK with encryption None",
        "sampleJson": {
          "enabled": false,
          "encryption": {
            "method": "None"
          }
        }
      }
    ]
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "bypassCNA" : {
            "description" : "By pass Capitive Network Assitance",
            "type" : [ "boolean", "null" ]
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT 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" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object",
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
        },
        "macAuth" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "enum" : [ "Default", "802.1X", "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})$"
                }
            },
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN."
        },
        "encryption" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "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" ],
            "description" : "Encryption of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required."
        },
        "operatorRealm" : {
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true "
        },
        "accountingServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Accounting of the WLAN"
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Web authorizationn portal service of the WLAN. The ID or name of the guest portal services within the zone is required."
        },
        "hotspot20Profile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
        },
        "defaultUserTrafficProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "User traffic profile of the WLAN"
        },
        "schedule" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ],
            "description" : "Schedule of the WLAN"
        },
        "vlan" : {
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "vlanPooling" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Vlan pooling"
                }
            },
            "type" : "object",
            "description" : "VLAN (access and/or core) of the WLAN."
        },
        "l2ACL" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Layer 2 ACL of the WLAN"
        },
        "devicePolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Device policy of the WLAN"
        },
        "radiusOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 63,
                    "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                }
            },
            "type" : "object",
            "description" : "RADIUS options of the WLAN"
        },
        "advancedOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "description" : "BSS minimum rate (mbps)"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Indicates wireless client isolation whitelist"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                    "type" : "boolean"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "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 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "description" : "Management TX rate (mbps)"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether OKC support is enabled or disabled",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether PKM caching support is enabled or disabled",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211dEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                }
            },
            "type" : "object",
            "description" : "Advanced settings for the WLAN."
        },
        "diffServProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DiffServ profile of the WLAN"
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "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" ]
                }
            },
            "description" : "DPSK Setting"
        },
        "externalDpsk" : {
            "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" ],
            "description" : "External DPSK Enabled"
        },
        "dnsServerProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DNS server profile of the WLAN"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot 2.0

POST/v5_1/rkszones/{zoneId}/wlans/hotspot20

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

Request
HideShow
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"
  },
  "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": {
    "multiSample": [
      {
        "sampleDescription": "Enable external DPSK with encryption WPA2 and radius authentication service of proxy mode",
        "sampleJson": {
          "enabled": true,
          "encryption": {
            "method": "WPA2",
            "algorithm": "AES"
          },
          "authService": {
            "id": "authServiceUUID"
          }
        }
      },
      {
        "sampleDescription": "Disable external DPSK with encryption None",
        "sampleJson": {
          "enabled": false,
          "encryption": {
            "method": "None"
          }
        }
      }
    ]
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "bypassCNA" : {
            "description" : "By pass Capitive Network Assitance",
            "type" : [ "boolean", "null" ]
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT 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" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object",
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
        },
        "macAuth" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "enum" : [ "Default", "802.1X", "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})$"
                }
            },
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN."
        },
        "encryption" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "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" ],
            "description" : "Encryption of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN"
        },
        "operatorRealm" : {
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true "
        },
        "accountingServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Accounting of the WLAN"
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs."
        },
        "hotspot20Profile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot 2.0 operator profile of the WLAN. The ID or name of the Hotspot 2.0 operator profiles within the zone is required."
        },
        "defaultUserTrafficProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "User traffic profile of the WLAN"
        },
        "schedule" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ],
            "description" : "Schedule of the WLAN"
        },
        "vlan" : {
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "vlanPooling" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Vlan pooling"
                }
            },
            "type" : "object",
            "description" : "VLAN (access and/or core) of the WLAN."
        },
        "l2ACL" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Layer 2 ACL of the WLAN"
        },
        "devicePolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Device policy of the WLAN"
        },
        "radiusOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 63,
                    "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                }
            },
            "type" : "object",
            "description" : "RADIUS options of the WLAN"
        },
        "advancedOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "description" : "BSS minimum rate (mbps)"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Indicates wireless client isolation whitelist"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                    "type" : "boolean"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "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 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "description" : "Management TX rate (mbps)"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether OKC support is enabled or disabled",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether PKM caching support is enabled or disabled",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211dEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                }
            },
            "type" : "object",
            "description" : "Advanced settings for the WLAN."
        },
        "diffServProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DiffServ profile of the WLAN"
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "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" ]
                }
            },
            "description" : "DPSK Setting"
        },
        "externalDpsk" : {
            "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" ],
            "description" : "External DPSK Enabled"
        },
        "dnsServerProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DNS server profile of the WLAN"
        }
    },
    "required" : [ "name", "ssid", "hotspot20Profile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot 2.0 OSEN

POST/v5_1/rkszones/{zoneId}/wlans/hotspot20osen

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

Request
HideShow
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"
  },
  "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": {
    "multiSample": [
      {
        "sampleDescription": "Enable external DPSK with encryption WPA2 and radius authentication service of proxy mode",
        "sampleJson": {
          "enabled": true,
          "encryption": {
            "method": "WPA2",
            "algorithm": "AES"
          },
          "authService": {
            "id": "authServiceUUID"
          }
        }
      },
      {
        "sampleDescription": "Disable external DPSK with encryption None",
        "sampleJson": {
          "enabled": false,
          "encryption": {
            "method": "None"
          }
        }
      }
    ]
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "bypassCNA" : {
            "description" : "By pass Capitive Network Assitance",
            "type" : [ "boolean", "null" ]
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT 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" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object",
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
        },
        "macAuth" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "enum" : [ "Default", "802.1X", "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})$"
                }
            },
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN."
        },
        "encryption" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "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" ],
            "description" : "Encryption of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN"
        },
        "operatorRealm" : {
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true "
        },
        "accountingServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Accounting of the WLAN"
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs."
        },
        "hotspot20Profile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
        },
        "defaultUserTrafficProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "User traffic profile of the WLAN"
        },
        "schedule" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ],
            "description" : "Schedule of the WLAN"
        },
        "vlan" : {
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "vlanPooling" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Vlan pooling"
                }
            },
            "type" : "object",
            "description" : "VLAN (access and/or core) of the WLAN."
        },
        "l2ACL" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Layer 2 ACL of the WLAN"
        },
        "devicePolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Device policy of the WLAN"
        },
        "radiusOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 63,
                    "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                }
            },
            "type" : "object",
            "description" : "RADIUS options of the WLAN"
        },
        "advancedOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "description" : "BSS minimum rate (mbps)"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Indicates wireless client isolation whitelist"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                    "type" : "boolean"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "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 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "description" : "Management TX rate (mbps)"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether OKC support is enabled or disabled",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether PKM caching support is enabled or disabled",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211dEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                }
            },
            "type" : "object",
            "description" : "Advanced settings for the WLAN."
        },
        "diffServProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DiffServ profile of the WLAN"
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "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" ]
                }
            },
            "description" : "DPSK Setting"
        },
        "externalDpsk" : {
            "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" ],
            "description" : "External DPSK Enabled"
        },
        "dnsServerProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DNS server profile of the WLAN"
        }
    },
    "required" : [ "name", "ssid" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Wechat

POST/v5_1/rkszones/{zoneId}/wlans/wechat

Use this API command to create a new wechat WLAN.

Request
HideShow
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"
  },
  "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": {
    "multiSample": [
      {
        "sampleDescription": "Enable external DPSK with encryption WPA2 and radius authentication service of proxy mode",
        "sampleJson": {
          "enabled": true,
          "encryption": {
            "method": "WPA2",
            "algorithm": "AES"
          },
          "authService": {
            "id": "authServiceUUID"
          }
        }
      },
      {
        "sampleDescription": "Disable external DPSK with encryption None",
        "sampleJson": {
          "enabled": false,
          "encryption": {
            "method": "None"
          }
        }
      }
    ]
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32,
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "bypassCNA" : {
            "description" : "By pass Capitive Network Assitance",
            "type" : [ "boolean", "null" ]
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT 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" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object",
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
        },
        "macAuth" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "enum" : [ "Default", "802.1X", "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})$"
                }
            },
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN."
        },
        "encryption" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "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" ],
            "description" : "Encryption of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN"
        },
        "operatorRealm" : {
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true "
        },
        "accountingServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Accounting of the WLAN"
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Wechat portal service of the WLAN. The ID or name of the wechat portal services within the zone is required."
        },
        "hotspot20Profile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
        },
        "defaultUserTrafficProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "User traffic profile of the WLAN"
        },
        "schedule" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ],
            "description" : "Schedule of the WLAN"
        },
        "vlan" : {
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "vlanPooling" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Vlan pooling"
                }
            },
            "type" : "object",
            "description" : "VLAN (access and/or core) of the WLAN."
        },
        "l2ACL" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Layer 2 ACL of the WLAN"
        },
        "devicePolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Device policy of the WLAN"
        },
        "radiusOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 63,
                    "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                }
            },
            "type" : "object",
            "description" : "RADIUS options of the WLAN"
        },
        "advancedOptions" : {
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "description" : "BSS minimum rate (mbps)"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Indicates wireless client isolation whitelist"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                    "type" : "boolean"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "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 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "description" : "Management TX rate (mbps)"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether OKC support is enabled or disabled",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "default" : true,
                    "description" : "Indicator of whether PKM caching support is enabled or disabled",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211dEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                }
            },
            "type" : "object",
            "description" : "Advanced settings for the WLAN."
        },
        "diffServProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DiffServ profile of the WLAN"
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "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" ]
                }
            },
            "description" : "DPSK Setting"
        },
        "externalDpsk" : {
            "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" ],
            "description" : "External DPSK Enabled"
        },
        "dnsServerProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DNS server profile of the WLAN"
        }
    },
    "required" : [ "name", "ssid", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Basic

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

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

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "accessTunnelType": "RuckusGRE",
  "operatorRealm": "operator realm"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 1,
    "maxLength": 32,
    "description": "Name of the WLAN"
  },
  "ssid": {
    "type": "string",
    "minLength": 1,
    "maxLength": 32,
    "description": "SSID of the WLAN"
  },
  "hessid": {
    "type": "string",
    "pattern": "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
    "description": "HESSID of the WLAN"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the WLAN"
  },
  "bypassCNA": {
    "description": "By pass Capitive Network Assitance",
    "type": [
      "boolean",
      "null"
    ]
  },
  "caleaEnabled": {
    "description": "DP CALEA Server Enabled",
    "type": "boolean"
  },
  "dpTunnelNatEnabled": {
    "description": "DP Tunnel NAT 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"
    ]
  },
  "operatorRealm": {
    "type": "string",
    "maxLength": 255,
    "pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
    "description": "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true "
  }
}
Response  204

Modify Authentication

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/authServiceOrProfile

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

Request
HideShow
Body
{
  "throughController": true,
  "id": "authServiceUUID",
  "locationDeliveryEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "throughController": {
      "description": "Indicates whether authentication messages were sent through the controller or not",
      "type": "boolean"
    },
    "id": {
      "description": "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
      "type": "string"
    },
    "name": {
      "description": "Name of the authentication service or profile. At least one ID or name is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
      "type": "string"
    },
    "locationDeliveryEnabled": {
      "description": "RFC5580 location delivery support",
      "type": "boolean"
    }
  },
  "description": "Authentication of the WLAN"
}
Response  204

Modify MAC Auth

PATCH/v5_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).

Request
HideShow
Body
{
  "macAuthMacFormat": "802.1X",
  "customizedPassword": "password"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "macAuthMacFormat" : {
            "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
            "enum" : [ "Default", "802.1X", "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})$"
        }
    },
    "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN."
}
Response  204

Modify Accounting

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/accountingServiceOrProfile

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

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

Disable Accounting

DELETE/v5_1/rkszones/{zoneId}/wlans/{id}/accountingServiceOrProfile

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

Response  204

Modify Encryption

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/encryption

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

Request
HideShow
Body
{
  "method": "WPA2",
  "algorithm": "AES",
  "passphrase": "password",
  "mfp": "disabled",
  "support80211rEnabled": true,
  "mobilityDomainId": 3
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "method": {
      "description": "Encryption method",
      "enum": [
        "WPA2",
        "WPA_Mixed",
        "WEP_64",
        "WEP_128",
        "None"
      ]
    },
    "algorithm": {
      "description": "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
      "enum": [
        "AES",
        "TKIP_AES"
      ]
    },
    "passphrase": {
      "description": "Passphrase. This only applies to WPA2 and WPA mixed mode.",
      "type": "string"
    },
    "mfp": {
      "description": "Management frame protection. This only applies to WPA2 + AES",
      "enum": [
        "disabled",
        "capable",
        "required"
      ]
    },
    "keyIndex": {
      "description": "Key index. This only applies to WEP64 and WEP128.",
      "type": "integer"
    },
    "keyInHex": {
      "description": "Key in hex format. This only applies to WEP64 and WEP128.",
      "type": "string"
    },
    "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"
  ],
  "description": "Encryption of the WLAN"
}
Response  204

Modify Core Tunnel

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/coreTunnelProfile

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

Request
HideShow
Body
{
  "type": "Bridge",
  "id": "forwardingUUID",
  "name": "forwardingName"
}
Schema
{
  "additionalProperties": false,
  "properties": {
    "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"
    },
    "type": {
      "description": "Tunnel type",
      "enum": [
        "Bridge"
      ]
    }
  },
  "required": [
    "type"
  ],
  "type": "object",
  "description": "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
}
Response  204

Modify Portal Profile

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/portalServiceProfile

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

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

Modify Hotspot20 Profile

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/hotspot20Profile

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

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

Modify User Traffic Profile

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/defaultUserTrafficProfile

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

Request
HideShow
Body
{
  "id": "userTrafficUUID",
  "name": "userTrafficName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "User traffic profile of the WLAN"
}
Response  204

Modify Schedule

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/schedule

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

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

Modify VLAN

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/vlan

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

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

Modify Layer 2 ACL

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/l2ACL

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

Request
HideShow
Body
{
  "id": "l2ACLUUID",
  "name": "l2ACLName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Layer 2 ACL of the WLAN"
}
Response  204

Disable Layer 2 ACL

DELETE/v5_1/rkszones/{zoneId}/wlans/{id}/l2ACL

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

Response  204

Modify Device Policy

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/devicePolicy

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

Request
HideShow
Body
{
  "id": "devicePolicyUUID",
  "name": "devicePolicyName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Device policy of the WLAN"
}
Response  204

Disable Device Policy

DELETE/v5_1/rkszones/{zoneId}/wlans/{id}/devicePolicy

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

Response  204

Modify RADIUS Options

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/radiusOptions

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

Request
HideShow
Body
{
  "nasIdType": "Customized",
  "customizedNasId": "nasId",
  "nasRequestTimeoutSec": 12,
  "nasMaxRetry": 3,
  "nasReconnectPrimaryMin": 30,
  "calledStaIdType": "WLAN_BSSID",
  "nasIpType": "disabled",
  "nasIpUserDefined": "192.168.1.1"
}
Schema
{
  "additionalProperties": false,
  "properties": {
    "calledStaIdType": {
      "default": "WLAN_BSSID",
      "description": "Called station ID type",
      "enum": [
        "AP_MAC",
        "NONE",
        "WLAN_BSSID"
      ]
    },
    "customizedNasId": {
      "description": "User defined NAS ID",
      "maxLength": 63,
      "pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$",
      "type": "string"
    },
    "nasIdType": {
      "default": "WLAN_BSSID",
      "description": "NAS ID type",
      "enum": [
        "AP_MAC",
        "Customized",
        "WLAN_BSSID"
      ]
    },
    "nasMaxRetry": {
      "default": 2,
      "description": "NAS request maximum retry",
      "maximum": 10,
      "minimum": 2,
      "type": "integer"
    },
    "nasReconnectPrimaryMin": {
      "default": 5,
      "description": "NAS reconnect primary time in minutes",
      "maximum": 60,
      "minimum": 1,
      "type": "integer"
    },
    "nasRequestTimeoutSec": {
      "default": 3,
      "description": "NAS request timeout in seconds",
      "maximum": 20,
      "minimum": 2,
      "type": "integer"
    },
    "nasIpType": {
      "description": "NAS IP type",
      "enum": [
        "disabled",
        "control",
        "userDefined"
      ],
      "default": "disabled"
    },
    "nasIpUserDefined": {
      "description": "User-defined NAS IP",
      "type": "string",
      "maxLength": 45
    }
  },
  "type": "object",
  "description": "RADIUS options of the WLAN"
}
Response  204

Modify Advanced Options

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/advancedOptions

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

Request
HideShow
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",
  "uplinkEnabled": false,
  "downlinkEnabled": false,
  "avcEnabled": true
}
Schema
{
  "additionalProperties": false,
  "properties": {
    "avcEnabled": {
      "default": false,
      "description": "Indicator of whether AVC support is enabled or disabled",
      "type": "boolean"
    },
    "bandBalancing": {
      "default": "UseZoneSetting",
      "description": "Indicates whether band balancing is enabled or disabled",
      "enum": [
        "Disabled",
        "UseZoneSetting"
      ]
    },
    "bssMinRateMbps": {
      "enum": [
        "Disable",
        "1 mbps",
        "2 mbps",
        "5.5 mbps",
        "12 mbps",
        "24 mbps"
      ],
      "description": "BSS minimum rate (mbps)"
    },
    "clientFingerprintingEnabled": {
      "default": false,
      "description": "Indicates whether client fingerprinting is enabled or disabled",
      "type": "boolean"
    },
    "clientIdleTimeoutSec": {
      "default": 120,
      "description": "Client idle timeout in seconds",
      "maximum": 1000,
      "minimum": 60,
      "type": "integer"
    },
    "clientIsolationEnabled": {
      "default": true,
      "description": "Indicates whether wireless client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationWhitelist": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "Indicates wireless client isolation whitelist"
    },
    "clientLoadBalancingEnabled": {
      "description": "Indicates whether Client Load Balancing is enabled or disabled",
      "type": "boolean"
    },
    "dgafEnabled": {
      "description": "Indicates whether dgaf is enabled or disabled",
      "type": "boolean"
    },
    "dhcp82Format": {
      "description": "DHCP Option 82 format",
      "enum": [
        "RUCKUS_DEFAULT",
        "SOFTGRE_CUSTOMIZED"
      ]
    },
    "dhcpOption82Enabled": {
      "default": false,
      "description": "Indicates whether DCHP Option 82 is enabled or disabled",
      "type": "boolean"
    },
    "downlinkEnabled": {
      "default": false,
      "description": "SSID Rate Limiting downlink enabled.",
      "type": "boolean"
    },
    "downlinkRate": {
      "description": "SSID Rate Limiting downlink.",
      "type": "number"
    },
    "forceClientDHCPTimeoutSec": {
      "default": 0,
      "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
      ]
    },
    "hideSsidEnabled": {
      "default": false,
      "description": "Indicates whether the SSID is hidden or broadcast",
      "type": "boolean"
    },
    "maxClientsPerRadio": {
      "default": 100,
      "description": "Maximum number of clients per radio",
      "maximum": 512,
      "minimum": 1,
      "type": "integer"
    },
    "mgmtTxRateMbps": {
      "enum": [
        "1 mbps",
        "2 mbps",
        "5.5 mbps",
        "6 mbps",
        "9 mbps",
        "11 mbps",
        "12 mbps",
        "18 mbps",
        "24 mbps",
        "36 mbps",
        "48 mbps",
        "54 mbps"
      ],
      "description": "Management TX rate (mbps)"
    },
    "ofdmOnlyEnabled": {
      "default": false,
      "description": "Indicates whether OFDM only is enabled or disabled",
      "type": "boolean"
    },
    "okcEnabled": {
      "default": true,
      "description": "Indicator of whether OKC support is enabled or disabled",
      "type": "boolean"
    },
    "pmkCachingEnabled": {
      "default": true,
      "description": "Indicator of whether PKM caching support is enabled or disabled",
      "type": "boolean"
    },
    "priority": {
      "default": "High",
      "description": "Priority of the WLAN",
      "enum": [
        "High",
        "Low"
      ]
    },
    "proxyARPEnabled": {
      "default": false,
      "description": "Indicates whether proxy ARP is enabled or disabled",
      "type": "boolean"
    },
    "support80211dEnabled": {
      "default": false,
      "description": "Indicates whether support for 802.11d is enabled or disabled",
      "type": "boolean"
    },
    "support80211kEnabled": {
      "default": true,
      "description": "Indicates whether support for 802.11k is enabled or disabled",
      "type": "boolean"
    },
    "unauthClientStatsEnabled": {
      "default": true,
      "description": "Indicates whether to send statistics of unauthorized clients or not",
      "type": "boolean"
    },
    "uplinkEnabled": {
      "default": false,
      "description": "SSID Rate Limiting uplink enabled.",
      "type": "boolean"
    },
    "uplinkRate": {
      "description": "SSID Rate Limiting uplink.",
      "type": "number"
    },
    "ratePerSTAUplink": {
      "description": "UE Rate Limiting uplink.",
      "type": "string"
    },
    "ratePerSTADownlink": {
      "description": "UE Rate Limiting downlink.",
      "type": "string"
    }
  },
  "type": "object",
  "description": "Advanced settings for the WLAN."
}
Response  204

Modify DiffServ Profile

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/diffServProfile

Use this API command to modify the DiffServ profile of a WLAN.

Request
HideShow
Body
{
  "id": "diffServId",
  "name": "diffServName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "DiffServ profile of the WLAN"
}
Response  204

Disable DiffServ Profile

DELETE/v5_1/rkszones/{zoneId}/wlans/{id}/diffServProfile

Use this API command to disable the DiffServ profile of a WLAN.

Response  204

Enable Qos Map Set

POST/v5_1/rkszones/{zoneId}/wlans/{id}/qosMaps

Use this API command to enable Qos Map Set of a WLAN.

Response  201

Modify Qos Map Set

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/qosMaps

Use this API command to modify Qos Map Set of a WLAN.

Request
HideShow
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"
    ]
  }
}
Response  204

Disable Qos Map Set

DELETE/v5_1/rkszones/{zoneId}/wlans/{id}/qosMaps

Use this API command to disable Qos Map Set of a WLAN.

Response  204

Delete

DELETE/v5_1/rkszones/{zoneId}/wlans/{id}

Use this API command to delete a WLAN.

Response  204

Modify DNS server profile

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/dnsServerProfile

Use this API command to modify DNS server profile of a WLAN.

Request
HideShow
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "DNS server profile of the WLAN"
}
Response  204

Disable DNS server profile

DELETE/v5_1/rkszones/{zoneId}/wlans/{id}/dnsServerProfile

Use this API command to disable DNS server profile of a WLAN.

Response  204

Modify DPSK Setting

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/dpsk

Use this API command to modify DPSK setting of a WLAN.

Request
HideShow
Body
{
  "dpskEnabled": true,
  "length": 8,
  "dpskType": "Secure",
  "expiration": "OneDay",
  "dpskFromType": "FirstUse"
}
Schema
{
  "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"
      ]
    }
  },
  "description": "DPSK Setting"
}
Response  204

Modify External DPSK Setting

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/externalDpsk

Use this API command to modify External DPSK setting of a WLAN.

Request
HideShow
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
{
    "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" ],
    "description" : "External DPSK Enabled"
}
Response  204

WLAN Scheduler

Retrieve List

GET/v5_1/rkszones/{zoneId}/wlanSchedulers

Use this API command to retrieve the list of WLAN schedule from a zone.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the WLAN schedule"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the WLAN schedule"
          },
          "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/v5_1/rkszones/{zoneId}/wlanSchedulers/{id}

Use this API command to retrieve a WLAN schedule.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the WLAN schedule"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the WLAN schedule"
    },
    "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/v5_1/rkszones/{zoneId}/wlanSchedulers

Use this API command to create a new WLAN schedule.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the WLAN schedule"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the WLAN schedule"
    },
    "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"
  ]
}
Response  201
HideShow
Body
{
  "id": "wlanSchedulerUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the WLAN schedule",
      "type": "string"
    }
  }
}

Modify Basic

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

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

Request
HideShow
Body
{
  "name": "wlanSchedulerName",
  "description": "wlanSchedulerDescription"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the WLAN schedule"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the WLAN schedule"
  }
}
Response  204

Modify Schedules On Sunday

PATCH/v5_1/rkszones/{zoneId}/wlanSchedulers/{id}/sun

Use this API command to modify schedules on Sunday.

Request
HideShow
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)$"
  }
}
Response  204

Modify Schedules On Monday

PATCH/v5_1/rkszones/{zoneId}/wlanSchedulers/{id}/mon

Use this API command to modify schedules on Monday.

Request
HideShow
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)$"
  }
}
Response  204

Modify Schedule On Tuesday

PATCH/v5_1/rkszones/{zoneId}/wlanSchedulers/{id}/tue

Use this API command to modify schedules on Tuesday.

Request
HideShow
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)$"
  }
}
Response  204

Modify Schedule On Wednesday

PATCH/v5_1/rkszones/{zoneId}/wlanSchedulers/{id}/wed

Use this API command to modify schedules on Wednesday.

Request
HideShow
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)$"
  }
}
Response  204

Modify Schedules On Thursday

PATCH/v5_1/rkszones/{zoneId}/wlanSchedulers/{id}/thu

Use this API command to modify schedules on Thursday.

Request
HideShow
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)$"
  }
}
Response  204

Modify Schedules On Friday

PATCH/v5_1/rkszones/{zoneId}/wlanSchedulers/{id}/fri

Use this API command to modify schedules on Friday.

Request
HideShow
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)$"
  }
}
Response  204

Modify Schedules On Saturday

PATCH/v5_1/rkszones/{zoneId}/wlanSchedulers/{id}/sat

Use this API command to modify schedules on Saturday.

Request
HideShow
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)$"
  }
}
Response  204

Delete

DELETE/v5_1/rkszones/{zoneId}/wlanSchedulers/{id}

Use this API command to delete a WLAN schedule.

Response  204

Zone AAA

Retrieve List - RADIUS

GET/v5_1/rkszones/{zoneId}/aaa/radius

Use this API command to retrieve a list of radius servers of a zone.

Response  200
HideShow
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"
      }
    }
  ]
}
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": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "type": "string",
                "description": "Server IP"
              },
              "port": {
                "description": "Server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "description": "Server shared secrect",
                "type": "string"
              }
            },
            "required": [
              "ip",
              "port",
              "sharedSecret"
            ],
            "description": "Primary RADIUS server"
          },
          "secondary": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "type": "string",
                "description": "Server IP"
              },
              "port": {
                "description": "Server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "description": "Server shared secrect",
                "type": "string"
              }
            },
            "required": [
              "ip",
              "port",
              "sharedSecret"
            ],
            "description": "Secondary RADIUS server"
          }
        }
      }
    }
  }
}

Retrieve - RADIUS

GET/v5_1/rkszones/{zoneId}/aaa/radius/{id}

Use this API command to retrieve a radius server of a zone.

Response  200
HideShow
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"
  }
}
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": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string",
          "description": "Server IP"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ],
      "description": "Primary RADIUS server"
    },
    "secondary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string",
          "description": "Server IP"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ],
      "description": "Secondary RADIUS server"
    }
  }
}

Create - RADIUS

POST/v5_1/rkszones/{zoneId}/aaa/radius

Use this API command to create a new radius server of a zone.

URI Parameters
HideShow
forAccounting
boolean (optional) 

radius server for accounting type. default: false.

Request
HideShow
Body
{
  "name": "RADIUSServerName",
  "primary": {
    "ip": "192.168.1.1",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the RADIUS server"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the RADIUS server"
    },
    "primary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string",
          "description": "Server IP"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ],
      "description": "Primary RADIUS server"
    },
    "secondary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string",
          "description": "Server IP"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ],
      "description": "Secondary RADIUS server"
    }
  },
  "required": [
    "name",
    "primary"
  ]
}
Response  201
HideShow
Body
{
  "id": "RADIUSServerUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify - RADIUS

PATCH/v5_1/rkszones/{zoneId}/aaa/radius/{id}

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

Request
HideShow
Body
{
  "name": "RADIUSServerName",
  "description": "RADIUSServerDescription"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the RADIUS server"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the RADIUS server"
  }
}
Response  204

Modify - Primary Server of RADIUS

PATCH/v5_1/rkszones/{zoneId}/aaa/radius/{id}/primary

Use this API command to modify primary server on radius server of a zone.

Request
HideShow
Body
{
  "ip": "192.168.1.1",
  "port": 1812,
  "sharedSecret": "abc"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ip": {
      "type": "string",
      "description": "Server IP"
    },
    "port": {
      "description": "Server port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "sharedSecret": {
      "description": "Server shared secrect",
      "type": "string"
    }
  },
  "required": [
    "ip",
    "port",
    "sharedSecret"
  ],
  "description": "Primary RADIUS server"
}
Response  204

Modify - Secondary Server of RADIUS

PATCH/v5_1/rkszones/{zoneId}/aaa/radius/{id}/secondary

Use this API command to modify secondary server on radius server of a zone.

Request
HideShow
Body
{
  "ip": "192.168.1.2",
  "port": 1812,
  "sharedSecret": "sharedSecret"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ip": {
      "type": "string",
      "description": "Server IP"
    },
    "port": {
      "description": "Server port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "sharedSecret": {
      "description": "Server shared secrect",
      "type": "string"
    }
  },
  "required": [
    "ip",
    "port",
    "sharedSecret"
  ],
  "description": "Secondary RADIUS server"
}
Response  204

Disable Secondary Server - RADIUS

DELETE/v5_1/rkszones/{zoneId}/aaa/radius/{id}/secondary

Use this API command to disable secondary server on radius server of a zone.

Response  204

Delete - RADIUS

DELETE/v5_1/rkszones/{zoneId}/aaa/radius/{id}

Use this API command to delete a radius server of a zone.

Response  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, and no longer be supported.

Response  200
HideShow
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": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "type": "string",
                "description": "Server IP"
              },
              "port": {
                "description": "Server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "description": "Server shared secrect",
                "type": "string"
              }
            },
            "required": [
              "ip",
              "port",
              "sharedSecret"
            ],
            "description": "Primary RADIUS server"
          },
          "secondary": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "type": "string",
                "description": "Server IP"
              },
              "port": {
                "description": "Server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "description": "Server shared secrect",
                "type": "string"
              }
            },
            "required": [
              "ip",
              "port",
              "sharedSecret"
            ],
            "description": "Secondary RADIUS server"
          }
        }
      }
    }
  }
}

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, and no longer be supported.

Response  200
HideShow
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": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string",
          "description": "Server IP"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ],
      "description": "Primary RADIUS server"
    },
    "secondary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string",
          "description": "Server IP"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ],
      "description": "Secondary RADIUS server"
    }
  }
}

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, and no longer be supported.

Request
HideShow
Body
{
  "name": "accountingServerName",
  "primary": {
    "ip": "192.168.1.1",
    "port": 1813,
    "sharedSecret": "sharedSecret"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the accounting server"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the accounting server"
    },
    "primary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string",
          "description": "Server IP"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ],
      "description": "Primary RADIUS server"
    },
    "secondary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string",
          "description": "Server IP"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ],
      "description": "Secondary RADIUS server"
    }
  },
  "required": [
    "name",
    "primary"
  ]
}
Response  201
HideShow
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, and no longer be supported.

Request
HideShow
Body
{
  "name": "accountingServerName",
  "description": "accountingServerDescription"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the accounting server"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the accounting server"
  }
}
Response  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, and no longer be supported.

Request
HideShow
Body
{
  "ip": "1.1.1.1",
  "port": 1813,
  "sharedSecret": "abc"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ip": {
      "type": "string",
      "description": "Server IP"
    },
    "port": {
      "description": "Server port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "sharedSecret": {
      "description": "Server shared secrect",
      "type": "string"
    }
  },
  "required": [
    "ip",
    "port",
    "sharedSecret"
  ],
  "description": "Primary RADIUS server"
}
Response  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, and no longer be supported.

Request
HideShow
Body
{
  "ip": "192.168.1.2",
  "port": 1813,
  "sharedSecret": "sharedSecret"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ip": {
      "type": "string",
      "description": "Server IP"
    },
    "port": {
      "description": "Server port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "sharedSecret": {
      "description": "Server shared secrect",
      "type": "string"
    }
  },
  "required": [
    "ip",
    "port",
    "sharedSecret"
  ],
  "description": "Secondary RADIUS server"
}
Response  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, and no longer be supported.

Response  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, and no longer be supported.

Response  204

Retrieve List - ActiveDirectory

GET/v5_1/rkszones/{zoneId}/aaa/ad

Use this API command to retrieve a list of active directory servers of a zone.

Response  200
HideShow
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
    }
  ]
}
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"
          }
        }
      }
    }
  }
}

Retrieve - ActiveDirectory

GET/v5_1/rkszones/{zoneId}/aaa/ad/{id}

Use this API command to retrieve an active directory server of a zone.

Response  200
HideShow
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
}
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"
    }
  }
}

Create - ActiveDirectory

POST/v5_1/rkszones/{zoneId}/aaa/ad

Use this API command to create a new active directory server of a zone.

Request
HideShow
Body
{
  "name": "activeDirectoryServerName",
  "ip": "192.168.1.1",
  "port": 389,
  "globalCatalogEnabled": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the active directory server"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the active directory server"
    },
    "ip": {
      "type": "string",
      "description": "IP address"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535,
      "default": 389
    },
    "windowsDomainName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Windows domain name"
    },
    "adminDomainName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Admin domain name"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "globalCatalogEnabled": {
      "description": "Enable global catalog support",
      "type": "boolean"
    }
  },
  "required": [
    "name",
    "ip",
    "port",
    "globalCatalogEnabled"
  ]
}
Response  201
HideShow
Body
{
  "id": "RADIUSServerUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify - ActiveDirectory

PATCH/v5_1/rkszones/{zoneId}/aaa/ad/{id}

Use this API command to modify the basic information on active directory server of a zone.

Request
HideShow
Body
{
  "name": "new name",
  "ip": "192.168.1.2",
  "port": 3268,
  "adminDomainName": "[email protected]",
  "password": "admin",
  "globalCatalogEnabled": true
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the active directory server"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the active directory server"
  },
  "ip": {
    "type": "string",
    "description": "IP address"
  },
  "port": {
    "description": "Port",
    "type": "integer",
    "minimum": 1,
    "maximum": 65535,
    "default": 389
  },
  "windowsDomainName": {
    "type": "string",
    "minLength": 2,
    "maxLength": 64,
    "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
    "description": "Windows domain name"
  },
  "adminDomainName": {
    "type": "string",
    "minLength": 2,
    "maxLength": 64,
    "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
    "description": "Admin domain name"
  },
  "password": {
    "description": "Admin password",
    "type": "string"
  },
  "globalCatalogEnabled": {
    "description": "Enable global catalog support",
    "type": "boolean"
  }
}
Response  204

Delete - ActiveDirectory

DELETE/v5_1/rkszones/{zoneId}/aaa/ad/{id}

Use this API command to delete an active directory server of a zone.

Response  204

Retrieve List - LDAP

GET/v5_1/rkszones/{zoneId}/aaa/ldap

Use this API command to retrieve a list of LDAP servers of a zone.

Response  200
HideShow
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=*"
    }
  ]
}
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"
          }
        }
      }
    }
  }
}

Retrieve - LDAP

GET/v5_1/rkszones/{zoneId}/aaa/ldap/{id}

Use this API command to retrieve a LDAP server of a zone.

Response  200
HideShow
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=*"
}
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"
    }
  }
}

Create - LDAP

POST/v5_1/rkszones/{zoneId}/aaa/ldap

Use this API command to create a new LDAP server of a zone.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the LDAP server"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the LDAP server"
    },
    "ip": {
      "type": "string",
      "description": "IP address"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535,
      "default": 389
    },
    "baseDomainName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Base domain name"
    },
    "adminDomainName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Admin domain name"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "keyAttribute": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Key attribute"
    },
    "searchFilter": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Search filter"
    }
  },
  "required": [
    "name",
    "ip",
    "port",
    "baseDomainName",
    "adminDomainName",
    "password",
    "keyAttribute",
    "searchFilter"
  ]
}
Response  201
HideShow
Body
{
  "id": "RADIUSServerUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify - LDAP

PATCH/v5_1/rkszones/{zoneId}/aaa/ldap/{id}

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

Request
HideShow
Body
{
  "name": "rapheal-ldap2",
  "ip": "1.1.1.22",
  "port": 389,
  "baseDomainName": "dc=ldap",
  "adminDomainName": "ibm",
  "password": "admin",
  "keyAttribute": "uid",
  "searchFilter": "objectClass=*"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the LDAP server"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the LDAP server"
  },
  "ip": {
    "type": "string",
    "description": "IP address"
  },
  "port": {
    "description": "Port",
    "type": "integer",
    "minimum": 1,
    "maximum": 65535,
    "default": 389
  },
  "baseDomainName": {
    "type": "string",
    "minLength": 2,
    "maxLength": 64,
    "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
    "description": "Base domain name"
  },
  "adminDomainName": {
    "type": "string",
    "minLength": 2,
    "maxLength": 64,
    "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
    "description": "Admin domain name"
  },
  "password": {
    "description": "Admin password",
    "type": "string"
  },
  "keyAttribute": {
    "type": "string",
    "minLength": 2,
    "maxLength": 64,
    "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
    "description": "Key attribute"
  },
  "searchFilter": {
    "type": "string",
    "minLength": 2,
    "maxLength": 64,
    "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
    "description": "Search filter"
  }
}
Response  204

Delete - LDAP

DELETE/v5_1/rkszones/{zoneId}/aaa/ldap/{id}

Use this API command to delete a LDAP server of a zone.

Response  204

Web Authentication

Retrieve List

GET/v5_1/rkszones/{zoneId}/portals/webauth

Use this API command to retrieve a list of web authentication of a zone.

Response  200
HideShow
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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the service"
          }
        }
      }
    }
  }
}

Retrieve

GET/v5_1/rkszones/{zoneId}/portals/webauth/{id}

Use this API command to retrieve a web authentication of a zone.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the web authentication profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the web authentication profile"
    },
    "portalLanguage": {
      "description": "Portal language of the web authentication profile",
      "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": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "type": "string",
          "description": "Portal redirect URL"
        }
      },
      "description": "Redirect configuration of the web authentication profile"
    },
    "userSession": {
      "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
        }
      },
      "description": "User session of the web authentication profile"
    }
  }
}

Create

POST/v5_1/rkszones/{zoneId}/portals/webauth

Use this API command to create a new web authentication of a zone.

Request
HideShow
Body
{
  "name": "Web Authentication Create",
  "description": "Web Authentication Create Description"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the web authentication profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the web authentication profile"
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the created portal profile",
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/rkszones/{zoneId}/portals/webauth/{id}

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

Request
HideShow
Body
{
  "name": "Web Authentication Modify",
  "description": "Web Authentication Modify Description",
  "portalLanguage": "en_US"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the web authentication profile"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the web authentication profile"
  },
  "portalLanguage": {
    "description": "Portal language of the web authentication profile",
    "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"
    ]
  }
}
Response  204

Modify Redirect

PATCH/v5_1/rkszones/{zoneId}/portals/webauth/{id}/redirect

Use this API command to modify the redirect information on web authentication of a zone.

Request
HideShow
Body
{
  "url": "https://www.ruckuswireless.com"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "url": {
      "type": "string",
      "description": "Portal redirect URL"
    }
  },
  "description": "Redirect configuration of the web authentication profile"
}
Response  204

Redirect to URL user visit

DELETE/v5_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.

Response  204

Modify UserSession

PATCH/v5_1/rkszones/{zoneId}/portals/webauth/{id}/userSession

Use this API command to modify the user session on web authentication of a zone.

Request
HideShow
Body
{
  "timeoutInMin": 180,
  "gracePeriodInMin": 120
}
Schema
{
  "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
    }
  },
  "description": "User session of the web authentication profile"
}
Response  204

Delete

DELETE/v5_1/rkszones/{zoneId}/portals/webauth/{id}

Use this API command to delete an web authentication of a zone.

Response  204

Guest Access

Retrieve List

GET/v5_1/rkszones/{zoneId}/portals/guest

Use this API command to retrieve a list of guest access of a zone.

Response  200
HideShow
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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the service"
          }
        }
      }
    }
  }
}

Retrieve

GET/v5_1/rkszones/{zoneId}/portals/guest/{id}

Use this API command to retrieve guest access of a zone.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the guest access profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the guest access profile"
    },
    "portalCustomization": {
      "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"
      ],
      "description": "Portal customization of the guest access profile"
    },
    "redirect": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "type": "string",
          "description": "Portal redirect URL"
        }
      },
      "description": "Redirect configuration of the guest access profile"
    },
    "smsGateway": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "Portal SMS gateway of the guest access profile"
    },
    "userSession": {
      "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
        }
      },
      "description": "User session of the guest access profile"
    }
  }
}

Create

POST/v5_1/rkszones/{zoneId}/portals/guest

Use this API command to create new guest access of a zone.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the guest access profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the guest access profile"
    },
    "portalCustomization": {
      "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"
      ],
      "description": "Portal customization of the guest access profile"
    },
    "redirect": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "type": "string",
          "description": "Portal redirect URL"
        }
      },
      "description": "Redirect configuration of the guest access profile"
    },
    "smsGateway": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "Portal SMS gateway of the guest access profile"
    },
    "userSession": {
      "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
        }
      },
      "description": "Redirect configuration of the guest access profile"
    }
  },
  "required": [
    "name",
    "portalCustomization",
    "userSession"
  ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the created portal profile",
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/rkszones/{zoneId}/portals/guest/{id}

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

Request
HideShow
Body
{
  "name": "GuestAccessSmart",
  "description": "basic configuration test"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the guest access profile"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the guest access profile"
  }
}
Response  204

Modify redirect

PATCH/v5_1/rkszones/{zoneId}/portals/guest/{id}/redirect

Use this API command to modify the redirect information on guest access of a zone.

Request
HideShow
Body
{
  "url": "http://www.google.com"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "url": {
      "type": "string",
      "description": "Portal redirect URL"
    }
  },
  "description": "Redirect configuration of the guest access profile"
}
Response  204

Redirect to URL user visit

DELETE/v5_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.

Response  204

Modify SMS Gateway

PATCH/v5_1/rkszones/{zoneId}/portals/guest/{id}/smsGateway

Use this API command to modify SMS gateway on guest access of a zone.

Request
HideShow
Body
{
  "name": "defaultServer"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Portal SMS gateway of the guest access profile"
}
Response  204

Disable SMS Gateway

DELETE/v5_1/rkszones/{zoneId}/portals/guest/{id}/smsGateway

Use this API command to disable SMS gateway on guest access of a zone.

Response  204

Modify Portal Customization

PATCH/v5_1/rkszones/{zoneId}/portals/guest/{id}/portalCustomization

Use this API command to modify the portal customization on guest access of a zone.

Request
HideShow
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
{
  "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"
  ],
  "description": "Portal customization of the guest access profile"
}
Response  204

Modify User Session

PATCH/v5_1/rkszones/{zoneId}/portals/guest/{id}/userSession

Use this API command to modify the user session on guest access of a zone.

Request
HideShow
Body
{
  "timeoutInMin": 180,
  "gracePeriodInMin": 60
}
Schema
{
  "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
    }
  },
  "description": "User session of the guest access profile"
}
Response  204

Delete

DELETE/v5_1/rkszones/{zoneId}/portals/guest/{id}

Use this API command to delete guest access of a zone.

Response  204

User Traffic Profile

Retrieve List - User Traffic Profile by query critaria

POST/v5_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.

Request
HideShow
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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "f79b7400-dd6e-11e6-8486-64006a6a50c6",
      "name": "123",
      "description": "",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "defaultAction": "ALLOW",
      "appPolicyId": "",
      "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": "",
      "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" : {
            "type" : "object",
            "properties" : {
                "rbacMetadata" : {
                    "type" : "array",
                    "items" : {
                        "additionalProperties" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "description" : "extra information for User Traffic profile"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Identifier of the user traffic profile",
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                        "description" : "Name of the user traffic profile"
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the user traffic profile"
                    },
                    "defaultAction" : {
                        "description" : "Default action",
                        "default" : "ALLOW",
                        "enum" : [ "BLOCK", "ALLOW" ]
                    },
                    "uplinkRateLimiting" : {
                        "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$"
                            }
                        },
                        "description" : "Uplink rate limiting"
                    },
                    "downlinkRateLimiting" : {
                        "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$"
                            }
                        },
                        "description" : "Downlink rate limiting"
                    },
                    "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" : {
                                    "type" : [ "string", "null" ],
                                    "maxLength" : 64,
                                    "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                                    "description" : "Description of the traffic access control rule"
                                },
                                "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"
                    },
                    "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/v5_1/profiles/utp

Use this API command to retrieve a list of user traffic profile.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for profile"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the profile"
          }
        }
      }
    },
    "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/v5_1/profiles/utp/{id}

Use this API command to retrieve an user traffic profile.

Response  200
HideShow
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" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the user traffic profile"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the user traffic profile"
        },
        "defaultAction" : {
            "description" : "Default action",
            "default" : "ALLOW",
            "enum" : [ "BLOCK", "ALLOW" ]
        },
        "uplinkRateLimiting" : {
            "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$"
                }
            },
            "description" : "Uplink rate limiting"
        },
        "downlinkRateLimiting" : {
            "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$"
                }
            },
            "description" : "Downlink rate limiting"
        },
        "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" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the traffic access control rule"
                    },
                    "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"
        },
        "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/v5_1/profiles/utp

Use this API command to create a new user traffic profile.

Request
HideShow
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" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the user traffic profile"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the user traffic profile"
        },
        "defaultAction" : {
            "description" : "Default action",
            "default" : "ALLOW",
            "enum" : [ "BLOCK", "ALLOW" ]
        },
        "uplinkRateLimiting" : {
            "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$"
                }
            },
            "description" : "Uplink rate limiting"
        },
        "downlinkRateLimiting" : {
            "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$"
                }
            },
            "description" : "Downlink rate limiting"
        },
        "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" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the traffic access control rule"
                    },
                    "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"
        },
        "mvnoId" : {
            "description" : "Tenant UUID",
            "type" : "string"
        },
        "domainId" : {
            "description" : "Domain UUID",
            "type" : "string"
        }
    },
    "required" : [ "name", "defaultAction" ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify - User Traffic Profile

PATCH/v5_1/profiles/utp/{id}

Use this API command to modify the basic information of user traffic profile.

Request
HideShow
Body
{
  "name": "new-user-traffic-profile-name",
  "description": "user traffic profile description",
  "defaultAction": "ALLOW"
}
Schema
{
  "id": {
    "description": "Identifier of the user traffic profile",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the user traffic profile"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the user traffic profile"
  },
  "defaultAction": {
    "description": "Default action",
    "default": "ALLOW",
    "enum": [
      "BLOCK",
      "ALLOW"
    ]
  },
  "appPolicyId": {
    "description": "Application Policy UUID",
    "type": "string"
  },
  "mvnoId": {
    "description": "Tenant UUID",
    "type": "string"
  },
  "domainId": {
    "description": "Domain UUID",
    "type": "string"
  }
}
Response  204

Modify - IpAclRules

PATCH/v5_1/profiles/utp/{id}/ipAclRules

Use this API command to modify IP ACL rules of user traffic profile.

Request
HideShow
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": {
        "type": [
          "string",
          "null"
        ],
        "maxLength": 64,
        "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
        "description": "Description of the traffic access control rule"
      },
      "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"
    ]
  }
}
Response  204

Modify - uplinkRateLimiting

PATCH/v5_1/profiles/utp/{id}/uplinkRateLimiting

Use this API command to modify uplink rate limiting of user traffic profile.

Request
HideShow
Body
{
  "uplinkRateLimitingEnabled": true,
  "uplinkRateLimitingBps": "0.10 mbps"
}
Schema
{
    "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$"
        }
    },
    "description" : "Uplink rate limiting"
}
Response  204

Disable - uplinkRateLimiting

DELETE/v5_1/profiles/utp/{id}/uplinkRateLimiting

Use this API command to disable uplink rateLimiting of user traffic profile.

Response  204

Modify - downlinkRateLimiting

PATCH/v5_1/profiles/utp/{id}/downlinkRateLimiting

Use this API command to modify downlink rate limiting of user traffic profile.

Request
HideShow
Body
{
  "downlinkRateLimitingEnabled": true,
  "downlinkRateLimitingBps": "0.10 mbps"
}
Schema
{
    "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$"
        }
    },
    "description" : "Downlink rate limiting"
}
Response  204

Disable - downlinkRateLimiting

DELETE/v5_1/profiles/utp/{id}/downlinkRateLimiting

Use this API command to disable downlink rate limiting of user traffic profile.

Response  204

Delete - User Traffic Profile

DELETE/v5_1/profiles/utp/{id}

Use this API command to delete an user traffic profile.

Response  204

Delete

DELETE/v5_1/profiles/utp

Use this API command to delete a list of traffic profile.

Request
HideShow
Body
{
  "idList": [
    "f79b7400-dd6e-11e6-8486-64006a6a50c6",
    "6530a9e1-e9d6-11e6-952e-64006a6a50c6"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Clone

POST/v5_1/profiles/utp/clone/{id}

Use this API command to copy a traffic profile.

Request
HideShow
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"
    }
  }
}
Response  200
HideShow
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 Service

Retrieve List

GET/v5_1/rkszones/{zoneId}/portals/hotspot

Use this API command to retrieve a list of Hotspot (WISPr) of a zone.

Response  200
HideShow
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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the service"
          }
        }
      }
    }
  }
}

Retrieve

GET/v5_1/rkszones/{zoneId}/portals/hotspot/{id}

Use this API command to retrieve a Hotspot (WISPr) of zone.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the Hotspot"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the Hotspot"
    },
    "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": {
      "type": "string",
      "description": "Portal URL of the Hotspot"
    },
    "location": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "Portal location id",
          "type": "string"
        },
        "name": {
          "description": "Portal location name",
          "type": "string"
        }
      },
      "description": "Location of the Hotspot"
    },
    "redirect": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "type": "string",
          "description": "Portal redirect URL"
        }
      },
      "description": "Redirect configuration of the Hotspot"
    },
    "portalCustomization": {
      "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"
      ],
      "description": "Portal customization of the guest access profile"
    },
    "userSession": {
      "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
        }
      },
      "description": "User session of the Hotspot"
    },
    "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/v5_1/rkszones/{zoneId}/portals/hotspot/internal

Use this API command to create a new Hotspot (WISPr) with internal logon URL of a zone.MacAddressFormat.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the Hotspot"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the Hotspot"
    },
    "smartClientSupport": {
      "description": "Smart client support of the Hotspot",
      "enum": [
        "None",
        "Enabled"
      ]
    },
    "location": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "Portal location id",
          "type": "string"
        },
        "name": {
          "description": "Portal location name",
          "type": "string"
        }
      },
      "description": "Location of the Hotspot"
    },
    "redirect": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "type": "string",
          "description": "Portal redirect URL"
        }
      },
      "description": "Redirect configuration of the Hotspot"
    },
    "userSession": {
      "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
        }
      },
      "description": "User session of the Hotspot"
    },
    "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"
  ]
}
Response  201
HideShow
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/v5_1/rkszones/{zoneId}/portals/hotspot/external

Use this API command to create a new Hotspot (WISPr) with external logon URL of a zone.MacAddressFormat.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the Hotspot"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the Hotspot"
    },
    "smartClientSupport": {
      "description": "Smart client support of the Hotspot",
      "enum": [
        "None",
        "Enabled"
      ]
    },
    "portalUrl": {
      "type": "string",
      "description": "Portal URL of the Hotspot"
    },
    "location": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "Portal location id",
          "type": "string"
        },
        "name": {
          "description": "Portal location name",
          "type": "string"
        }
      },
      "description": "Location of the hotspot"
    },
    "redirect": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "type": "string",
          "description": "Portal redirect URL"
        }
      },
      "description": "Redirect configuration of the Hotspot"
    },
    "userSession": {
      "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
        }
      },
      "description": "User session of the Hotspot"
    },
    "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"
  ]
}
Response  201
HideShow
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/v5_1/rkszones/{zoneId}/portals/hotspot/smartClientOnly

Use this API command to create a new Hotspot (WISPr) with smart client only of a zone.MacAddressFormat.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the Hotspot"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the Hotspot"
    },
    "smartClientInfo": {
      "description": "Smart client info of the Hotspot. Type instructions for enabling users to log on using the Smart Client application.",
      "type": "string"
    },
    "location": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "Portal location id",
          "type": "string"
        },
        "name": {
          "description": "Portal location name",
          "type": "string"
        }
      },
      "description": "Location of the Hotspot"
    },
    "redirect": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "type": "string",
          "description": "Portal redirect URL"
        }
      },
      "description": "Redirect configuration of the Hotspot"
    },
    "userSession": {
      "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
        }
      },
      "description": "Redirect configuration of the Hotspot profile"
    },
    "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"
  ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the created portal profile",
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/rkszones/{zoneId}/portals/hotspot/{id}

Use this API command to modify the basic information on Hotspot (WISPr) of a zone.MacAddressFormat.

Request
HideShow
Body
{
  "name": "test-hotspot-modify",
  "description": "description-modify",
  "smartClientSupport": "Enabled",
  "portalUrl": "https://172.17.26.59",
  "macAddressFormat": 2,
  "httpsRedirect": true
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the Hotspot"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the Hotspot"
  },
  "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": {
    "type": "string",
    "description": "Portal URL of the Hotspot"
  },
  "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"
  }
}
Response  204

Modify Redirect

PATCH/v5_1/rkszones/{zoneId}/portals/hotspot/{id}/redirect

Use this API command to modify the redirect information on Hotspot (WISPr) of a zone.

Request
HideShow
Body
{
  "url": "https://www.testurl.com"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "url": {
      "type": "string",
      "description": "Portal redirect URL"
    }
  },
  "description": "Redirect configuration of the Hotspot"
}
Response  204

Modify Portal Customization

PATCH/v5_1/rkszones/{zoneId}/portals/hotspot/{id}/portalCustomization

Use this API command to modify portal customization on Hotspot (WISPr) of a zone.

Request
HideShow
Body
{
  "language": "en_US",
  "title": "Ruckus Wireless - Subscriber Portal",
  "logo": "logo",
  "termsAndConditionsRequired": false
}
Schema
{
  "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"
  ],
  "description": "Portal customization of the guest access profile"
}
Response  204

Modify Location

PATCH/v5_1/rkszones/{zoneId}/portals/hotspot/{id}/location

Use this API command to modify the location information on Hotspot (WISPr) of a zone.

Request
HideShow
Body
{
  "id": "locationId",
  "name": "locationName"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Portal location id",
      "type": "string"
    },
    "name": {
      "description": "Portal location name",
      "type": "string"
    }
  },
  "description": "Location of the Hotspot"
}
Response  204

Modify Walled Gardens

PATCH/v5_1/rkszones/{zoneId}/portals/hotspot/{id}/walledGardens

Use this API command to modify walled gardens on Hotspot (WISPr) of a zone.

Request
HideShow
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"
  }
}
Response  204

Delete

DELETE/v5_1/rkszones/{zoneId}/portals/hotspot/{id}

Use this API command to delete a Hotspot (WISPr) of a zone.

Response  204

Hotspot20 WLAN Profile

Retrieve List

GET/v5_1/rkszones/{zoneId}/hs20s

Use this API command to retrieve a list of Hotspot 2.0 WLAN profiles of a zone.

Response  200
HideShow
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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the service"
          }
        }
      }
    }
  }
}

Retrieve

GET/v5_1/rkszones/{zoneId}/hs20s/{id}

Use this API command to retrieve a Hotspot 2.0 WLAN profile of a zone.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the Hotspot 2.0 WLAN profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the Hotspot 2.0 WLAN profile"
    },
    "operator": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "Operator of the Hotspot 2.0 WLAN profile"
    },
    "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": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "Default identity provider of the Hotspot 2.0 WLAN profile"
    },
    "signupSsid": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "Signup SSID of the Hotspot 2.0 WLAN profile"
    },
    "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/v5_1/rkszones/{zoneId}/hs20s

Use this API command to create a new Hotspot 2.0 WLAN profile of a zone.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the Hotspot 2.0 WLAN profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the Hotspot 2.0 WLAN profile"
    },
    "operator": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "Operator of the Hotspot 2.0 WLAN profile"
    },
    "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": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "Default identity provider of the Hotspot 2.0 WLAN profile"
    },
    "signupSsid": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "Signup SSID of the Hotspot 2.0 WLAN profile"
    },
    "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"
  ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the created portal profile",
      "type": "string"
    }
  }
}

Modify Basic

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

Use this API command to modify the basic information on Hotspot 2.0 WLAN profile of a zone.

Request
HideShow
Body
{
  "name": "hotspot20WlanProfilePath",
  "description": "hotspot20 wlan profile pathc desc",
  "internetOption": true,
  "accessNetworkType": "CHARGEABLE_PUBLIC",
  "ipv4AddressType": "UNAVAILABLE",
  "ipv6AddressType": "UNAVAILABLE"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the Hotspot 2.0 WLAN profile"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the Hotspot 2.0 WLAN profile"
  },
  "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"
    ]
  }
}
Response  204

Modify Operator

PATCH/v5_1/rkszones/{zoneId}/hs20s/{id}/operator

Use this API command to modify operator profile on Hotspot 2.0 WLAN profile of a zone.

Request
HideShow
Body
{
  "id": "e6373c40-8194-11e4-aa2e-000c299b4765",
  "name": "operatorTEST"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Operator of the Hotspot 2.0 WLAN profile"
}
Response  204

Modify Identity Providers

PATCH/v5_1/rkszones/{zoneId}/hs20s/{id}/identityProviders

Use this API command to modify identity provider profiles on Hotspot 2.0 WLAN profile of a zone.

Request
HideShow
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"
      }
    }
  }
}
Response  204

Modify Default Identity Provider

PATCH/v5_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.

Request
HideShow
Body
{
  "id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
  "name": "identityProviderEnabled"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Default identity provider of the Hotspot 2.0 WLAN profile"
}
Response  204

Modify Signup SSID

PATCH/v5_1/rkszones/{zoneId}/hs20s/{id}/signupSsid

Use this API command to modify signup SSID on Hotspot 2.0 WLAN profile of a zone.

Request
HideShow
Body
{
  "id": "1",
  "name": "osenWlan"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Signup SSID of the Hotspot 2.0 WLAN profile"
}
Response  204

Modify Default Connection Capabilities

PATCH/v5_1/rkszones/{zoneId}/hs20s/{id}/connectionCapabilities

Use this API command to modify connection capabilities on Hotspot 2.0 WLAN profile of a zone.

Request
HideShow
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"
    ]
  }
}
Response  204

Modify Custom Connection Capabilities

PATCH/v5_1/rkszones/{zoneId}/hs20s/{id}/customConnectionCapabilities

Use this API command to modify custom connection capabilities on Hotspot 2.0 WLAN profile of a zone.

Request
HideShow
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"
    ]
  }
}
Response  204

Delete

DELETE/v5_1/rkszones/{zoneId}/hs20s/{id}

Use this API command to delete a Hotspot 2.0 WLAN Profile of a zone.

Response  204

Authentication Service

Retrieve List - All types of Authentication Service by query critaria

POST/v5_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.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for authentication servers"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the authentication service"
          },
          "friendlyName": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Friendly name of the authentication service"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the authentication service"
          },
          "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": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 32,
                      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                      "description": "Identity user role name"
                    },
                    "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/v5_1/services/auth/{id}

Use this API command to delete an authentication service.

Response  204

Delete a list of authentication Service

DELETE/v5_1/services/auth

Use this API command to delete a list of authentication service.

Request
HideShow
Body
{
  "idList": [
    "839f87c6-d116-497e-afce-aa8157abdasd"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Test specific authentication Service

POST/v5_1/services/auth/test/{id}

Use this API command to test an authentication service.

Request
HideShow
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"
        }
      }
    }
  }
}
Response  204

Retrieve - LocalDB Authentication Service

GET/v5_1/services/auth/local_db/{id}

Use this API command to retrieve a LocalDB authentication service.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the authentication service"
    },
    "friendlyName": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Friendly name of the authentication service"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the authentication service"
    },
    "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": {
                "type": "string",
                "minLength": 2,
                "maxLength": 32,
                "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                "description": "Identity user role name"
              },
              "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/v5_1/services/auth/local_db/{id}

Use this API command to update LocalDB authentication service.

Request
HideShow
Body
{
  "mvnoId": "897f87c6-d116-497e-afce-aa8157abd30c",
  "domainId": "8b3881d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "local db",
  "friendlyName": "aaa",
  "description": "ddd",
  "type": "LOCAL_DB"
}
Schema
{
  "id": {
    "description": "Identifier of the authentication service",
    "type": "string"
  },
  "mvnoId": {
    "description": "Tenant UUID",
    "type": "string"
  },
  "domainId": {
    "description": "Domain Id",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the RADIUS authentication service"
  },
  "friendlyName": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Friendly name of the authentication service"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the authentication service"
  },
  "protocol": {
    "description": "Authentication protocol.",
    "enum": [
      "LOCAL_DB"
    ]
  },
  "type": {
    "description": "Authentication protocol.",
    "enum": [
      "LOCAL_DB"
    ]
  }
}
Response  204

Update user role mappings of LocalDB Authentication Service

PATCH/v5_1/services/auth/local_db/{id}/mappings

Use this API command to update user role mappings of LocalDB authentication service.

Request
HideShow
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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Identity user role name"
          }
        }
      }
    },
    "required": [
      "groupAttr",
      "userRole"
    ]
  }
}
Response  204

Retrieve - Guest Authentication Service

GET/v5_1/services/auth/guest/{id}

Use this API command to retrieve a Guest authentication service.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the authentication service"
    },
    "friendlyName": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Friendly name of the authentication service"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the authentication service"
    },
    "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": {
                "type": "string",
                "minLength": 2,
                "maxLength": 32,
                "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                "description": "Identity user role name"
              },
              "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 critaria

POST/v5_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.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for radius authentication"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the RADIUS authentication service"
          },
          "friendlyName": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Friendly name of the RADIUS authentication service"
          },
          "protocol": {
            "description": "Authentication protocol.",
            "enum": [
              "RADIUS"
            ]
          },
          "type": {
            "description": "Authentication protocol.",
            "enum": [
              "RADIUS"
            ]
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the RADIUS authentication service"
          },
          "locationDeliveryEnabled": {
            "description": "RFC5580 out of band location delivery support(for Ruckus AP only)",
            "type": "boolean",
            "default": false
          },
          "primary": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "type": "string",
                "description": "Server IP"
              },
              "port": {
                "description": "Server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "description": "Server shared secrect",
                "type": "string"
              }
            },
            "required": [
              "ip",
              "port",
              "sharedSecret"
            ],
            "description": "Primary RADIUS server"
          },
          "secondary": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "autoFallbackDisable": {
                "description": "Automatic fallback enabled or disabled",
                "type": "boolean"
              },
              "ip": {
                "type": "string",
                "description": "RADIUS server IP"
              },
              "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"
            ],
            "description": "Secondary RADIUS server"
          },
          "healthCheckPolicy": {
            "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"
            ],
            "description": "Health check policy"
          },
          "rateLimiting": {
            "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"
            ],
            "description": "Rate limiting"
          },
          "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": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 32,
                      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                      "description": "Identity user role name"
                    },
                    "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/v5_1/services/auth/radius

Use this API command to retrieve a list of RADIUS authentication services.

Response  200
HideShow
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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for radius authentication"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the RADIUS authentication service"
          },
          "friendlyName": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Friendly name of the RADIUS authentication service"
          },
          "protocol": {
            "description": "Authentication protocol.",
            "enum": [
              "RADIUS"
            ]
          },
          "type": {
            "description": "Authentication protocol.",
            "enum": [
              "RADIUS"
            ]
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the RADIUS authentication service"
          },
          "locationDeliveryEnabled": {
            "description": "RFC5580 out of band location delivery support(for Ruckus AP only)",
            "type": "boolean",
            "default": false
          },
          "primary": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "type": "string",
                "description": "Server IP"
              },
              "port": {
                "description": "Server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "description": "Server shared secrect",
                "type": "string"
              }
            },
            "required": [
              "ip",
              "port",
              "sharedSecret"
            ],
            "description": "Primary RADIUS server"
          },
          "secondary": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "autoFallbackDisable": {
                "description": "Automatic fallback enabled or disabled",
                "type": "boolean"
              },
              "ip": {
                "type": "string",
                "description": "RADIUS server IP"
              },
              "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"
            ],
            "description": "Secondary RADIUS server"
          },
          "healthCheckPolicy": {
            "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"
            ],
            "description": "Health check policy"
          },
          "rateLimiting": {
            "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"
            ],
            "description": "Rate limiting"
          },
          "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": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 32,
                      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                      "description": "Identity user role name"
                    },
                    "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/v5_1/services/auth/radius/{id}

Use this API command to retrieve a RADIUS authentication service.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the RADIUS authentication service"
    },
    "friendlyName": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Friendly name of the RADIUS authentication service"
    },
    "protocol": {
      "description": "Authentication protocol.",
      "enum": [
        "RADIUS"
      ]
    },
    "type": {
      "description": "Authentication protocol.",
      "enum": [
        "RADIUS"
      ]
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the RADIUS authentication service"
    },
    "locationDeliveryEnabled": {
      "description": "RFC5580 out of band location delivery support(for Ruckus AP only)",
      "type": "boolean",
      "default": false
    },
    "primary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string",
          "description": "Server IP"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ],
      "description": "Primary RADIUS server"
    },
    "secondary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoFallbackDisable": {
          "description": "Automatic fallback enabled or disabled",
          "type": "boolean"
        },
        "ip": {
          "type": "string",
          "description": "RADIUS server IP"
        },
        "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"
      ],
      "description": "Secondary RADIUS server"
    },
    "healthCheckPolicy": {
      "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"
      ],
      "description": "Health check policy"
    },
    "rateLimiting": {
      "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"
      ],
      "description": "Rate limiting"
    },
    "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": {
                "type": "string",
                "minLength": 2,
                "maxLength": 32,
                "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                "description": "Identity user role name"
              },
              "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/v5_1/services/auth/radius

Use this API command to create a new RADIUS authentication service.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the RADIUS authentication service"
    },
    "friendlyName": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Friendly name of the RADIUS authentication service"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the RADIUS authentication service"
    },
    "locationDeliveryEnabled": {
      "description": "RFC5580 out of band location delivery support(for Ruckus AP only)",
      "type": "boolean",
      "default": false
    },
    "type": {
      "description": "",
      "enum": [
        "RADIUS"
      ]
    },
    "primary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string",
          "description": "Server IP"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ],
      "description": "Primary RADIUS server"
    },
    "secondary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoFallbackDisable": {
          "description": "Automatic fallback enabled or disabled",
          "type": "boolean"
        },
        "ip": {
          "type": "string",
          "description": "RADIUS server IP"
        },
        "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"
      ],
      "description": "Secondary RADIUS server"
    },
    "healthCheckPolicy": {
      "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"
      ],
      "description": "Health check policy"
    },
    "rateLimiting": {
      "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"
      ],
      "description": "Rate limiting"
    },
    "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": {
                "type": "string",
                "minLength": 2,
                "maxLength": 32,
                "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                "description": "Identity user role name"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  },
  "required": [
    "name",
    "primary"
  ]
}
Response  201
HideShow
Body
{
  "id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify - RADIUS Authentication Service

PATCH/v5_1/services/auth/radius/{id}

Use this API command to modify the basic information of a RADIUS authentication service.

Request
HideShow
Body
{
  "name": "new name",
  "description": "new description"
}
Schema
{
  "id": {
    "description": "Identifier of the authentication service",
    "type": "string"
  },
  "domainId": {
    "description": "Domain Id",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the RADIUS authentication service"
  },
  "friendlyName": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Friendly name of the RADIUS authentication service"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the RADIUS authentication service"
  },
  "locationDeliveryEnabled": {
    "description": "RFC5580 out of band location delivery support(for Ruckus AP only)",
    "type": "boolean",
    "default": false
  },
  "type": {
    "description": "",
    "enum": [
      "RADIUS"
    ]
  }
}
Response  204

Modify - Primary RADIUS Server of Authentication Service

PATCH/v5_1/services/auth/radius/{id}/primary

Use this API command to modify primary RADIUS server of a RADIUS authentication service.

Request
HideShow
Body
{
  "ip": "1.1.1.155",
  "port": 1812,
  "sharedSecret": "abc"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ip": {
      "type": "string",
      "description": "Server IP"
    },
    "port": {
      "description": "Server port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "sharedSecret": {
      "description": "Server shared secrect",
      "type": "string"
    }
  },
  "required": [
    "ip",
    "port",
    "sharedSecret"
  ],
  "description": "Primary RADIUS server"
}
Response  204

Modify - Secondary RADIUS Server of Authentication Service

PATCH/v5_1/services/auth/radius/{id}/secondary

Use this API command to modify secondary RADIUS server of a RADIUS authentication service.

Request
HideShow
Body
{
  "ip": "2.2.2.231",
  "port": 1812,
  "sharedSecret": "abc"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "autoFallbackDisable": {
      "description": "Automatic fallback enabled or disabled",
      "type": "boolean"
    },
    "ip": {
      "type": "string",
      "description": "RADIUS server IP"
    },
    "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"
  ],
  "description": "Secondary RADIUS server"
}
Response  204

Modify - Rate Limiting of Authentication Service

PATCH/v5_1/services/auth/radius/{id}/rateLimiting

Use this API command to modify rate limiting of a RADIUS authentication service.

Request
HideShow
Body
{
  "maxOutstandingRequestsPerServer": 0,
  "threshold": 0,
  "sanityTimer": 10
}
Schema
{
  "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"
  ],
  "description": "Rate limiting"
}
Response  204

Modify - Health Check Policy of Authentication Service

PATCH/v5_1/services/auth/radius/{id}/healthCheckPolicy

Use this API command to modify health check policy of a RADIUS authentication service.

Request
HideShow
Body
{
  "responseWindow": 20,
  "reviveInterval": 120,
  "zombiePeriod": 40
}
Schema
{
  "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"
  ],
  "description": "Health check policy"
}
Response  204

Modify - User Traffic Profile Mapping

PATCH/v5_1/services/auth/radius/{id}/mappings

Use this API command to modify user traffic profile mapping of a RADIUS authentication service.

Request
HideShow
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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Identity user role name"
          }
        }
      }
    },
    "required": [
      "groupAttr",
      "userRole"
    ]
  }
}
Response  204

Disable Secondary RADIUS Server of Authentication Service

DELETE/v5_1/services/auth/radius/{id}/secondary

Use this API command to disable secondary RADIUS server of a RADIUS authentication service.

Response  204

Delete - RADIUS Authentication Service

DELETE/v5_1/services/auth/radius/{id}

Use this API command to delete a RADIUS authentication service.

Response  204

Retrieve List - AD Authentication Service by query critaria

POST/v5_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.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for AD authentication service"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the active directory authentication service"
          },
          "friendlyName": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Friendly name of the active directory authentication service"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the active directory authentication service"
          },
          "ip": {
            "type": "string",
            "description": "IP address"
          },
          "port": {
            "description": "Port",
            "type": "integer",
            "minimum": 1,
            "maximum": 65535,
            "default": 389
          },
          "windowsDomainName": {
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
            "description": "Windows domain name"
          },
          "adminDomainName": {
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
            "description": "Admin domain name"
          },
          "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": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 32,
                      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                      "description": "Identity user role name"
                    },
                    "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/v5_1/services/auth/ad

Use this API command to retrieve a list of active directory authentication services.

Response  200
HideShow
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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for AD authentication service"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the active directory authentication service"
          },
          "friendlyName": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Friendly name of the active directory authentication service"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the active directory authentication service"
          },
          "ip": {
            "type": "string",
            "description": "IP address"
          },
          "port": {
            "description": "Port",
            "type": "integer",
            "minimum": 1,
            "maximum": 65535,
            "default": 389
          },
          "windowsDomainName": {
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
            "description": "Windows domain name"
          },
          "adminDomainName": {
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
            "description": "Admin domain name"
          },
          "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": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 32,
                      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                      "description": "Identity user role name"
                    },
                    "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/v5_1/services/auth/ad/{id}

Use this API command to retrieve an active directory authentication service.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the active directory authentication service"
    },
    "friendlyName": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Friendly name of the active directory authentication service"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the active directory authentication service"
    },
    "ip": {
      "type": "string",
      "description": "IP address"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535,
      "default": 389
    },
    "windowsDomainName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Windows domain name"
    },
    "adminDomainName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Admin domain name"
    },
    "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": {
                "type": "string",
                "minLength": 2,
                "maxLength": 32,
                "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                "description": "Identity user role name"
              },
              "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/v5_1/services/auth/ad

Use this API command to create a new active directory authentication service.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the active directory authentication service"
    },
    "friendlyName": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Friendly name of the active directory authentication service"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the active directory authentication service"
    },
    "ip": {
      "type": "string",
      "description": "IP address"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535,
      "default": 389
    },
    "windowsDomainName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Windows domain name"
    },
    "adminDomainName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Admin domain name"
    },
    "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": {
                "type": "string",
                "minLength": 2,
                "maxLength": 32,
                "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                "description": "Identity user role name"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  },
  "required": [
    "name",
    "ip",
    "port",
    "windowsDomainName",
    "globalCatalogEnabled",
    "tlsEnabled"
  ]
}
Response  201
HideShow
Body
{
  "id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify - Active Directory Authentication Service

PATCH/v5_1/services/auth/ad/{id}

Use this API command to modify the basic information of an active directory authentication service.

Request
HideShow
Body
{
  "adminDomainName": "[email protected]",
  "password": "newpassword",
  "globalCatalogEnabled": true
}
Schema
{
  "id": {
    "description": "Identifier of the authentication service",
    "type": "string"
  },
  "domainId": {
    "description": "Domain Id",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the active directory authentication service"
  },
  "friendlyName": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Friendly name of the active directory authentication service"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the active directory authentication service"
  },
  "type": {
    "description": "Authentication protocol.",
    "enum": [
      "AD"
    ]
  },
  "ip": {
    "type": "string",
    "description": "IP address"
  },
  "port": {
    "description": "Port",
    "type": "integer",
    "minimum": 1,
    "maximum": 65535,
    "default": 389
  },
  "windowsDomainName": {
    "type": "string",
    "minLength": 2,
    "maxLength": 64,
    "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
    "description": "Windows domain name"
  },
  "adminDomainName": {
    "type": "string",
    "minLength": 2,
    "maxLength": 64,
    "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
    "description": "Admin domain name"
  },
  "password": {
    "description": "Admin password",
    "type": "string"
  },
  "tlsEnabled": {
    "description": "AD over TLS Enabled",
    "type": "boolean"
  },
  "globalCatalogEnabled": {
    "description": "Global catalog support enabled or disabled",
    "type": "boolean"
  }
}
Response  204

Modify - User Traffic Profile Mapping of Active Directory

PATCH/v5_1/services/auth/ad/{id}/mappings

Use this API command to modify user traffic profile mapping of an active directory authentication service.

Request
HideShow
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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Identity user role name"
          }
        }
      }
    },
    "required": [
      "groupAttr",
      "userRole"
    ]
  }
}
Response  204

Delete - Active Directory Authentication Service

DELETE/v5_1/services/auth/ad/{id}

Use this API command to delete an active directory authentication service.

Response  204

Retrieve List - LDAP Authentication Service by query critaria

POST/v5_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.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for ldap authentication service"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the LDAP authentication service"
          },
          "friendlyName": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Friendly name of the LDAP authentication service"
          },
          "protocol": {
            "description": "Authentication protocol",
            "enum": [
              "LDAP"
            ]
          },
          "type": {
            "description": "Authentication protocol same as protocol.",
            "enum": [
              "LDAP"
            ]
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the LDAP authentication service"
          },
          "tlsEnabled": {
            "description": "LDAP over TLS Enabled",
            "type": "boolean"
          },
          "ip": {
            "type": "string",
            "description": "IP address"
          },
          "port": {
            "description": "Port",
            "type": "integer"
          },
          "baseDomainName": {
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
            "description": "Base domain name"
          },
          "adminDomainName": {
            "type": "string",
            "minLength": 2,
            "maxLength": 128,
            "pattern": "^[!-~]([ -~]){0,126}[!-~]$",
            "description": "Admin domain name"
          },
          "password": {
            "description": "Admin password",
            "type": "string"
          },
          "keyAttribute": {
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
            "description": "Key attribute"
          },
          "searchFilter": {
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
            "description": "Search filter"
          },
          "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": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 32,
                      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                      "description": "Identity user role name"
                    },
                    "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/v5_1/services/auth/ldap

Use this API command to retrieve a list of LDAP authentication services.

Response  200
HideShow
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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for ldap authentication service"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the LDAP authentication service"
          },
          "friendlyName": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Friendly name of the LDAP authentication service"
          },
          "protocol": {
            "description": "Authentication protocol",
            "enum": [
              "LDAP"
            ]
          },
          "type": {
            "description": "Authentication protocol same as protocol.",
            "enum": [
              "LDAP"
            ]
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the LDAP authentication service"
          },
          "tlsEnabled": {
            "description": "LDAP over TLS Enabled",
            "type": "boolean"
          },
          "ip": {
            "type": "string",
            "description": "IP address"
          },
          "port": {
            "description": "Port",
            "type": "integer"
          },
          "baseDomainName": {
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
            "description": "Base domain name"
          },
          "adminDomainName": {
            "type": "string",
            "minLength": 2,
            "maxLength": 128,
            "pattern": "^[!-~]([ -~]){0,126}[!-~]$",
            "description": "Admin domain name"
          },
          "password": {
            "description": "Admin password",
            "type": "string"
          },
          "keyAttribute": {
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
            "description": "Key attribute"
          },
          "searchFilter": {
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
            "description": "Search filter"
          },
          "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": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 32,
                      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                      "description": "Identity user role name"
                    },
                    "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/v5_1/services/auth/ldap/{id}

Use this API command to retrieve a LDAP authentication service.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the LDAP authentication service"
    },
    "friendlyName": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Friendly name of the LDAP authentication service"
    },
    "protocol": {
      "description": "Authentication protocol",
      "enum": [
        "LDAP"
      ]
    },
    "type": {
      "description": "Authentication protocol same as protocol.",
      "enum": [
        "LDAP"
      ]
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the LDAP authentication service"
    },
    "tlsEnabled": {
      "description": "LDAP over TLS Enabled",
      "type": "boolean"
    },
    "ip": {
      "type": "string",
      "description": "IP address"
    },
    "port": {
      "description": "Port",
      "type": "integer"
    },
    "baseDomainName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Base domain name"
    },
    "adminDomainName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 128,
      "pattern": "^[!-~]([ -~]){0,126}[!-~]$",
      "description": "Admin domain name"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "keyAttribute": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Key attribute"
    },
    "searchFilter": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Search filter"
    },
    "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": {
                "type": "string",
                "minLength": 2,
                "maxLength": 32,
                "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                "description": "Identity user role name"
              },
              "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/v5_1/services/auth/ldap

Use this API command to create a new LDAP authentication service.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the LDAP authentication service"
    },
    "friendlyName": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Friendly name of the LDAP authentication service"
    },
    "type": {
      "description": "Authentication protocol.",
      "enum": [
        "LDAP"
      ]
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the LDAP authentication service"
    },
    "tlsEnabled": {
      "description": "LDAP over TLS Enabled",
      "type": "boolean"
    },
    "ip": {
      "type": "string",
      "description": "IP address"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535,
      "default": 389
    },
    "baseDomainName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Base domain name"
    },
    "adminDomainName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 128,
      "pattern": "^[!-~]([ -~]){0,126}[!-~]$",
      "description": "Admin domain name"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "keyAttribute": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Key attribute"
    },
    "searchFilter": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "Search filter"
    },
    "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": {
                "type": "string",
                "minLength": 2,
                "maxLength": 32,
                "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                "description": "Identity user role name"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  },
  "required": [
    "name",
    "ip",
    "port",
    "baseDomainName",
    "adminDomainName",
    "password",
    "keyAttribute",
    "searchFilter",
    "tlsEnabled"
  ]
}
Response  201
HideShow
Body
{
  "id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify - LDAP Authentication Service

PATCH/v5_1/services/auth/ldap/{id}

Use this API command to modify the basic information of a LDAP authentication service.

Request
HideShow
Body
{
  "friendlyName": "new name",
  "description": "new description",
  "tlsEnabled": true
}
Schema
{
  "id": {
    "description": "Identifier of the authentication service",
    "type": "string"
  },
  "domainId": {
    "description": "Domain Id",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the LDAP authentication service"
  },
  "friendlyName": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Friendly name of the LDAP authentication service"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the LDAP authentication service"
  },
  "type": {
    "description": "Authentication protocol same as protocol.",
    "enum": [
      "LDAP"
    ]
  },
  "tlsEnabled": {
    "description": "LDAP over TLS Enabled",
    "type": "boolean"
  },
  "ip": {
    "type": "string",
    "description": "IP address"
  },
  "port": {
    "description": "Port",
    "type": "integer",
    "minimum": 1,
    "maximum": 65535,
    "default": 389
  },
  "baseDomainName": {
    "type": "string",
    "minLength": 2,
    "maxLength": 64,
    "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
    "description": "Base domain name"
  },
  "adminDomainName": {
    "type": "string",
    "minLength": 2,
    "maxLength": 128,
    "pattern": "^[!-~]([ -~]){0,126}[!-~]$",
    "description": "Admin domain name"
  },
  "password": {
    "description": "Admin password",
    "type": "string"
  },
  "keyAttribute": {
    "type": "string",
    "minLength": 2,
    "maxLength": 64,
    "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
    "description": "Key attribute"
  },
  "searchFilter": {
    "type": "string",
    "minLength": 2,
    "maxLength": 64,
    "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
    "description": "Search filter"
  }
}
Response  204

Modify - User Traffic Profile Mapping of LDAP

PATCH/v5_1/services/auth/ldap/{id}/mappings

Use this API command to modify user traffic profile mapping of a LDAP authentication service.

Request
HideShow
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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Identity user role name"
          }
        }
      }
    },
    "required": [
      "groupAttr",
      "userRole"
    ]
  }
}
Response  204

Delete - LDAP Authentication Service

DELETE/v5_1/services/auth/ldap/{id}

Use this API command to delete a LDAP authentication service.

Response  204

Retrieve List - oAuth Authentication Service by query critaria

POST/v5_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.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for oauth authentication service"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the OAuth authentication service"
          },
          "friendlyName": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Friendly name of the oAuth authentication service"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the OAuth authentication service"
          },
          "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": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 32,
                      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                      "description": "Identity user role name"
                    },
                    "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/v5_1/services/auth/oauth

Use this API command to retrieve a list of OAuth authentication service.

Response  200
HideShow
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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for oauth authentication service"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the OAuth authentication service"
          },
          "friendlyName": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Friendly name of the oAuth authentication service"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the OAuth authentication service"
          },
          "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": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 32,
                      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                      "description": "Identity user role name"
                    },
                    "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/v5_1/services/auth/oauth/{id}

Use this API command to retrieve a OAuth authentication service.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the OAuth authentication service"
    },
    "friendlyName": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Friendly name of the oAuth authentication service"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the OAuth authentication service"
    },
    "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": {
                "type": "string",
                "minLength": 2,
                "maxLength": 32,
                "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                "description": "Identity user role name"
              },
              "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/v5_1/services/auth/oauth

Use this API command to create a new OAuth authentication service.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the OAuth authentication service"
    },
    "friendlyName": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Friendly name of the LDAP authentication service"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the OAuth authentication service"
    },
    "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": {
                "type": "string",
                "minLength": 2,
                "maxLength": 32,
                "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                "description": "Identity user role name"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  },
  "required": [
    "type",
    "name",
    "applicationId",
    "applicationSecret",
    "willCollectEmail"
  ]
}
Response  201
HideShow
Body
{
  "id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify - OAuth Authentication Service

PATCH/v5_1/services/auth/oauth/{id}

Use this API command to modify the basic information of an OAuth authentication service.

Request
HideShow
Body
{
  "name": "globalOauth",
  "description": "modify oAuthAuthentication desc",
  "applicationId": "test",
  "applicationSecret": "test",
  "willCollectEmail": true
}
Schema
{
  "id": {
    "description": "Identifier of the authentication service",
    "type": "string"
  },
  "domainId": {
    "description": "Domain Id",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the OAuth authentication service"
  },
  "friendlyName": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Friendly name of the LDAP authentication service"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the OAuth authentication service"
  },
  "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"
  }
}
Response  204

Modify - Whitelisted Domains of OAuth

PATCH/v5_1/services/auth/oauth/{id}/whitelistedDomains

Use this API command to modify whitelisted domains of an OAuth authentication service.

Request
HideShow
Body
[
  "ruckus.com"
]
Schema
{
  "description": "Admin domain name",
  "type": "array",
  "items": {
    "type": "string"
  }
}
Response  204

Modify - User Traffic Profile Mapping of OAuth

PATCH/v5_1/services/auth/oauth/{id}/mappings

Use this API command to modify user traffic profile mapping of an OAuth authentication service.

Request
HideShow
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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Identity user role name"
          }
        }
      }
    },
    "required": [
      "groupAttr",
      "userRole"
    ]
  }
}
Response  204

Delete - OAuth Authentication Service

DELETE/v5_1/services/auth/oauth/{id}

Use this API command to delete an OAuth authentication service.

Response  204

Accounting Service

Retrieve List - All types of Accounting Service by query critaria

POST/v5_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.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for accounting servers"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the accounting service"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the accounting service"
          },
          "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/v5_1/services/acct/{id}

Use this API command to delete an accounting service.

Response  204

Delete a list of Accounting Service

DELETE/v5_1/services/acct

Use this API command to delete a list of accounting service.

Request
HideShow
Body
{
  "idList": [
    "839f87c6-d116-497e-afce-aa8157abdasd"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Test specific Accounting Service

POST/v5_1/services/acct/test/{id}

Use this API command to test an accounting service.

Request
HideShow
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"
        }
      }
    }
  }
}
Response  200

Retrieve List - Radius Accounting Service by query critaria

POST/v5_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.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for radius accounting server"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the RADIUS accounting service"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the RADIUS accounting service"
          },
          "primary": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "type": "string",
                "description": "Server IP"
              },
              "port": {
                "description": "Server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "description": "Server shared secrect",
                "type": "string"
              }
            },
            "required": [
              "ip",
              "port",
              "sharedSecret"
            ],
            "description": "Primary RADIUS server"
          },
          "secondary": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "autoFallbackDisable": {
                "description": "Automatic fallback enabled or disabled",
                "type": "boolean"
              },
              "ip": {
                "type": "string",
                "description": "RADIUS server IP"
              },
              "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"
            ],
            "description": "Secondary RADIUS server"
          },
          "healthCheckPolicy": {
            "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"
            ],
            "description": "Health check policy"
          },
          "rateLimiting": {
            "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"
            ],
            "description": "Rate limiting"
          },
          "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/v5_1/services/acct/radius

Use this API command to retrieve a list of RADIUS accounting services.

Response  200
HideShow
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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for radius accounting server"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the RADIUS accounting service"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the RADIUS accounting service"
          },
          "primary": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "type": "string",
                "description": "Server IP"
              },
              "port": {
                "description": "Server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "description": "Server shared secrect",
                "type": "string"
              }
            },
            "required": [
              "ip",
              "port",
              "sharedSecret"
            ],
            "description": "Primary RADIUS server"
          },
          "secondary": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "autoFallbackDisable": {
                "description": "Automatic fallback enabled or disabled",
                "type": "boolean"
              },
              "ip": {
                "type": "string",
                "description": "RADIUS server IP"
              },
              "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"
            ],
            "description": "Secondary RADIUS server"
          },
          "healthCheckPolicy": {
            "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"
            ],
            "description": "Health check policy"
          },
          "rateLimiting": {
            "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"
            ],
            "description": "Rate limiting"
          },
          "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/v5_1/services/acct/radius/{id}

Use this API command to retrieve a RADIUS accounting service.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the RADIUS accounting service"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the RADIUS accounting service"
    },
    "primary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string",
          "description": "Server IP"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ],
      "description": "Primary RADIUS server"
    },
    "secondary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoFallbackDisable": {
          "description": "Automatic fallback enabled or disabled",
          "type": "boolean"
        },
        "ip": {
          "type": "string",
          "description": "RADIUS server IP"
        },
        "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"
      ],
      "description": "Secondary RADIUS server"
    },
    "healthCheckPolicy": {
      "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"
      ],
      "description": "Health check policy"
    },
    "rateLimiting": {
      "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"
      ],
      "description": "Rate limiting"
    },
    "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/v5_1/services/acct/radius

Use this API command to create a new RADIUS accounting service.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the RADIUS accounting service"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "protocol": {
      "description": "Accounting protocol.",
      "enum": [
        "RADIUS"
      ]
    },
    "type": {
      "description": "Accounting protocol.",
      "enum": [
        "RADIUS"
      ]
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the RADIUS accounting service"
    },
    "primary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string",
          "description": "Server IP"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ],
      "description": "Primary RADIUS server"
    },
    "secondary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoFallbackDisable": {
          "description": "Automatic fallback enabled or disabled",
          "type": "boolean"
        },
        "ip": {
          "type": "string",
          "description": "RADIUS server IP"
        },
        "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"
      ],
      "description": "Secondary RADIUS server"
    },
    "healthCheckPolicy": {
      "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"
      ],
      "description": "Health check policy"
    },
    "rateLimiting": {
      "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"
      ],
      "description": "Rate limiting"
    }
  },
  "required": [
    "name",
    "primary"
  ]
}
Response  201
HideShow
Body
{
  "id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify - RADIUS Accounting Service

PATCH/v5_1/services/acct/radius/{id}

Use this API command to modify the basic information of a RADIUS accounting service.

Request
HideShow
Body
{
  "name": "new name",
  "description": "new description"
}
Schema
{
  "id": {
    "description": "Identifier of the RADIUS accounting service",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the RADIUS accounting service"
  },
  "domainId": {
    "description": "Domain Id",
    "type": "string"
  },
  "protocol": {
    "description": "Accounting protocol.",
    "enum": [
      "RADIUS"
    ]
  },
  "type": {
    "description": "Accounting protocol.",
    "enum": [
      "RADIUS"
    ]
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the RADIUS accounting service"
  }
}
Response  204

Modify - Primary RADIUS Server of Accounting Service

PATCH/v5_1/services/acct/radius/{id}/primary

Use this API command to modify primary RADIUS server of a RADIUS accounting service.

Request
HideShow
Body
{
  "ip": "192.168.1.1",
  "port": 1812,
  "sharedSecret": "sharedSecret"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ip": {
      "type": "string",
      "description": "Server IP"
    },
    "port": {
      "description": "Server port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "sharedSecret": {
      "description": "Server shared secrect",
      "type": "string"
    }
  },
  "required": [
    "ip",
    "port",
    "sharedSecret"
  ],
  "description": "Primary RADIUS server"
}
Response  204

Modify - Secondary RADIUS Server of Accounting Service

PATCH/v5_1/services/acct/radius/{id}/secondary

Use this API command to modify secondary RADIUS server of a RADIUS accounting service.

Request
HideShow
Body
{
  "ip": "192.168.1.2",
  "port": 1812,
  "sharedSecret": "sharedSecret"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "autoFallbackDisable": {
      "description": "Automatic fallback enabled or disabled",
      "type": "boolean"
    },
    "ip": {
      "type": "string",
      "description": "RADIUS server IP"
    },
    "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"
  ],
  "description": "Secondary RADIUS server"
}
Response  204

Modify - Rate Limiting of Accounting Service

PATCH/v5_1/services/acct/radius/{id}/rateLimiting

Use this API command to modify rate limiting of a RADIUS accounting service.

Request
HideShow
Body
{
  "maxOutstandingRequestsPerServer": 0,
  "threshold": 0,
  "sanityTimer": 10
}
Schema
{
  "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"
  ],
  "description": "Rate limiting"
}
Response  204

Modify - Health Check Policy of Accounting Service

PATCH/v5_1/services/acct/radius/{id}/healthCheckPolicy

Use this API command to modify health check policy of a RADIUS accounting service.

Request
HideShow
Body
{
  "responseWindow": 20,
  "reviveInterval": 120,
  "zombiePeriod": 40
}
Schema
{
  "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"
  ],
  "description": "Health check policy"
}
Response  204

Disable Secondary RADIUS Server of Accounting Service

DELETE/v5_1/services/acct/radius/{id}/secondary

Use this API command to disable secondary RADIUS server of a RADIUS accounting service.

Response  204

Delete - RADIUS Accounting Service

DELETE/v5_1/services/acct/radius/{id}

Use this API command to delete a RADIUS accounting service.

Response  204

Authentication Service Profile

Retrieve List - authentication service info.

POST/v5_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.

Request
HideShow
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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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"
          }
        }
      }
    }
  }
}

Hotspot20 Venue Profile

Retrieve List

GET/v5_1/rkszones/{zoneId}/hs20/venues

Use this API command to retrieve a list of Hotspot 2.0 venue profile of a zone.

Response  200
HideShow
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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the service"
          }
        }
      }
    }
  }
}

Retrieve

GET/v5_1/rkszones/{zoneId}/hs20/venues/{id}

Use this API command to retrieve a Hotspot 2.0 venue profile of a zone.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the Hotspot 2.0 venue profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the Hotspot 2.0 venue profile"
    },
    "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": "Downlink Speed of the Hotspot 2.0 venue profile",
      "type": "number",
      "minimum": 0,
      "maximum": 4294967295
    },
    "uplinkSpeedInKbps": {
      "description": "Uplink Speed of the Hotspot 2.0 venue profile",
      "type": "number",
      "minimum": 0,
      "maximum": 4294967295
    },
    "venueNames": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "language": {
            "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"
            ],
            "description": "Friendly name of venue"
          },
          "name": {
            "description": "Venue name",
            "type": "string"
          }
        },
        "required": [
          "language",
          "name"
        ]
      }
    }
  }
}

Create

POST/v5_1/rkszones/{zoneId}/hs20/venues

Use this API command to create a new Hotspot 2.0 venue profile of a zone.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the Hotspot 2.0 venue profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the Hotspot 2.0 venue profile"
    },
    "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": "Downlink Speed of the Hotspot 2.0 venue profile",
      "type": "number",
      "minimum": 0,
      "maximum": 4294967295
    },
    "uplinkSpeedInKbps": {
      "description": "Uplink Speed of the Hotspot 2.0 venue profile",
      "type": "number",
      "minimum": 0,
      "maximum": 4294967295
    },
    "venueNames": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "language": {
            "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"
            ],
            "description": "Friendly name of venue"
          },
          "name": {
            "description": "Venue name",
            "type": "string"
          }
        },
        "required": [
          "language",
          "name"
        ]
      }
    }
  },
  "required": [
    "name",
    "venueNames"
  ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the created portal profile",
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/rkszones/{zoneId}/hs20/venues/{id}

Use this API command to modify the basic information on Hotspot 2.0 venue profile of a zone.

Request
HideShow
Body
{
  "name": "test-hs20Venue-modify",
  "description": "des-hs20Venue-modify",
  "group": "UtilityAndMiscellaneous",
  "type": "Unspecified",
  "downlinkSpeedInKbps": 111111,
  "uplinkSpeedInKbps": 11111
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the Hotspot 2.0 venue profile"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the Hotspot 2.0 venue profile"
  },
  "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": "Downlink Speed of the Hotspot 2.0 venue profile",
    "type": "number",
    "minimum": 0,
    "maximum": 4294967295
  },
  "uplinkSpeedInKbps": {
    "description": "Uplink Speed of the Hotspot 2.0 venue profile",
    "type": "number",
    "minimum": 0,
    "maximum": 4294967295
  }
}
Response  204

Modify Venue Names

PATCH/v5_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.

Request
HideShow
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": {
        "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"
        ],
        "description": "Friendly name of venue"
      },
      "name": {
        "description": "Venue name",
        "type": "string"
      }
    },
    "required": [
      "language",
      "name"
    ]
  }
}
Response  204

Delete

DELETE/v5_1/rkszones/{zoneId}/hs20/venues/{id}

Use this API command to delete Hotspot 2.0 venue profile of a zone.

Response  204

Hotspot20 Wi-Fi Operator Profile

Retrieve List

GET/v5_1/profiles/hs20/operators

Use this API command to retrieve list of Hotspot 2.0 Wi-Fi Operators.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 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" : {
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                        "description" : "Name of the Hotspot 2.0 Wifi operator profile"
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the Hotspot 2.0 Wifi operator profile"
                    },
                    "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" : {
                                    "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" ],
                                    "description" : "Language of the friendly name"
                                },
                                "name" : {
                                    "description" : "Name of the friendly name",
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32
                                }
                            },
                            "required" : [ "language", "name" ]
                        }
                    },
                    "certificate" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        },
                        "description" : "Signup security certificate"
                    },
                    "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/v5_1/profiles/hs20/operators/{id}

Use this API command to retrieve a Hotspot 2.0 Wi-Fi operator.

Response  200
HideShow
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" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the Hotspot 2.0 Wifi operator profile"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Hotspot 2.0 Wifi operator profile"
        },
        "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" : {
                        "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" ],
                        "description" : "Language of the friendly name"
                    },
                    "name" : {
                        "description" : "Name of the friendly name",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32
                    }
                },
                "required" : [ "language", "name" ]
            }
        },
        "certificate" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Signup security certificate"
        },
        "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/v5_1/profiles/hs20/operators

Use this API command to create a new Hotspot 2.0 Wi-Fi operator.

Request
HideShow
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" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the Hotspot 2.0 Wifi operator profile"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Hotspot 2.0 Wifi operator profile"
        },
        "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" : {
                        "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" ],
                        "description" : "Language of the friendly name"
                    },
                    "name" : {
                        "description" : "Name of the friendly name",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32
                    }
                },
                "required" : [ "language", "name" ]
            }
        },
        "certificate" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Signup security certificate"
        },
        "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" ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/profiles/hs20/operators/{id}

Use this API command to modify the basic information of a Hotspot 2.0 Wi-Fi operator.

Request
HideShow
Body
{
  "name": "public-api-operator-changed",
  "description": "description-changed"
}
Schema
{
  "id": {
    "description": "Identifier of the profile",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the Hotspot 2.0 Wifi operator profile"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the Hotspot 2.0 Wifi operator profile"
  },
  "domainId": {
    "description": "Domain Id",
    "type": "string"
  }
}
Response  204

Modify Domain Names

PATCH/v5_1/profiles/hs20/operators/{id}/domainNames

Use this API command to modify domain names of a Hotspot 2.0 Wi-Fi operator.

Request
HideShow
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})$"
    }
}
Response  204

Modify Friendly Names

PATCH/v5_1/profiles/hs20/operators/{id}/friendlyNames

Use this API command to modify friendly names of a Hotspot 2.0 Wi-Fi operator.

Request
HideShow
Body
[
  {
    "language": "English",
    "name": "ruckus"
  }
]
Schema
{
  "description": "Friendly names",
  "type": "array",
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "language": {
        "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"
        ],
        "description": "Language of the friendly name"
      },
      "name": {
        "description": "Name of the friendly name",
        "type": "string",
        "minLength": 2,
        "maxLength": 32
      }
    },
    "required": [
      "language",
      "name"
    ]
  }
}
Response  204

Modify Certificate

PATCH/v5_1/profiles/hs20/operators/{id}/certificate

Use this API command to enable or modify certificate of a Hotspot 2.0 Wi-Fi operator.

Request
HideShow
Body
{
  "id": "certificateID",
  "name": "certificateName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Signup security certificate"
}
Response  204

Disable Certificate

DELETE/v5_1/profiles/hs20/operators/{id}/certificate

Use this API command to disable certificate of a Hotspot 2.0 Wi-Fi operator.

Response  204

Delete

DELETE/v5_1/profiles/hs20/operators/{id}

Use this API command to delete a Hotspot 2.0 Wi-Fi operator.

Response  204

Delete

DELETE/v5_1/profiles/hs20/operators

Use this API command to delete multiple Hotspot 2.0 Wi-Fi operators.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Query hotspot 2.0 Wi-Fi operators

POST/v5_1/profiles/hs20/operators/query

Query hotspot 2.0 Wi-Fi operators. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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" : {
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                        "description" : "Name of the Hotspot 2.0 Wifi operator profile"
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the Hotspot 2.0 Wifi operator profile"
                    },
                    "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" : {
                                    "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" ],
                                    "description" : "Language of the friendly name"
                                },
                                "name" : {
                                    "description" : "Name of the friendly name",
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32
                                }
                            },
                            "required" : [ "language", "name" ]
                        }
                    },
                    "certificate" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        },
                        "description" : "Signup security certificate"
                    },
                    "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/v5_1/profiles/hs20/identityproviders

Use this API command to retrieve list of Hotspot 2.0 identity providers.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 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" : {
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                        "description" : "Name of the Hotspot 2.0 identity provider profile"
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the Hotspot 2.0 identity provider profile"
                    },
                    "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" : {
                                    "type" : "string",
                                    "maxLength" : 255,
                                    "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                    "description" : "Authentication realm"
                                },
                                "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" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "type" : {
                                "description" : "Online singup type",
                                "enum" : [ "Internal", "External" ]
                            },
                            "internalOSU" : {
                                "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" : {
                                                "type" : [ "object", "null" ],
                                                "additionalProperties" : false,
                                                "properties" : {
                                                    "id" : {
                                                        "type" : "string"
                                                    },
                                                    "name" : {
                                                        "type" : "string"
                                                    }
                                                },
                                                "description" : "Internal online singup portal, required when type is Internal"
                                            },
                                            "externalUrl" : {
                                                "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})*)?$",
                                                "description" : "External online singup portal, start with https://, required when type is External"
                                            }
                                        },
                                        "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" : {
                                                    "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" ],
                                                    "description" : "Language of the friendly name"
                                                },
                                                "name" : {
                                                    "description" : "Name of the friendly name",
                                                    "type" : "string",
                                                    "minLength" : 2,
                                                    "maxLength" : 32
                                                },
                                                "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" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        },
                                        "description" : "Online signup certificate"
                                    },
                                    "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" : {
                                                    "type" : "string",
                                                    "maxLength" : 255,
                                                    "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                                    "description" : "Authentication realm"
                                                },
                                                "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" ],
                                "description" : "Internal online singup, required when type is Internal"
                            },
                            "externalOSU" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "provisioningProtocals" : {
                                        "description" : "Provisioning protocal",
                                        "type" : "array",
                                        "item" : {
                                            "enum" : [ "SOAP_XML", "OMA_DM" ]
                                        }
                                    },
                                    "osuServiceUrl" : {
                                        "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})*)?$",
                                        "description" : "External service URL, start with https://"
                                    },
                                    "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" : {
                                                    "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" ],
                                                    "description" : "Language of the friendly name"
                                                },
                                                "name" : {
                                                    "description" : "Name of the friendly name",
                                                    "type" : "string",
                                                    "minLength" : 2,
                                                    "maxLength" : 32
                                                },
                                                "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" ],
                                "description" : "External online singup, required when type is External"
                            }
                        },
                        "required" : [ "type" ],
                        "description" : "Online Signup & Provisioning"
                    },
                    "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/v5_1/profiles/hs20/identityproviders/{id}

Use this API command to retrieve a Hotspot 2.0 identity provider.

Response  200
HideShow
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" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the Hotspot 2.0 identity provider profile"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Hotspot 2.0 identity provider profile"
        },
        "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" : {
                        "type" : "string",
                        "maxLength" : 255,
                        "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                        "description" : "Authentication realm"
                    },
                    "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" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Online singup type",
                    "enum" : [ "Internal", "External" ]
                },
                "internalOSU" : {
                    "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" : {
                                    "type" : [ "object", "null" ],
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "id" : {
                                            "type" : "string"
                                        },
                                        "name" : {
                                            "type" : "string"
                                        }
                                    },
                                    "description" : "Internal online singup portal, required when type is Internal"
                                },
                                "externalUrl" : {
                                    "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})*)?$",
                                    "description" : "External online singup portal, start with https://, required when type is External"
                                }
                            },
                            "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" : {
                                        "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" ],
                                        "description" : "Language of the friendly name"
                                    },
                                    "name" : {
                                        "description" : "Name of the friendly name",
                                        "type" : "string",
                                        "minLength" : 2,
                                        "maxLength" : 32
                                    },
                                    "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" : {
                            "type" : [ "object", "null" ],
                            "additionalProperties" : false,
                            "properties" : {
                                "id" : {
                                    "type" : "string"
                                },
                                "name" : {
                                    "type" : "string"
                                }
                            },
                            "description" : "Online signup certificate"
                        },
                        "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" : {
                                        "type" : "string",
                                        "maxLength" : 255,
                                        "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                        "description" : "Authentication realm"
                                    },
                                    "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" ],
                    "description" : "Internal online singup, required when type is Internal"
                },
                "externalOSU" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "provisioningProtocals" : {
                            "description" : "Provisioning protocal",
                            "type" : "array",
                            "item" : {
                                "enum" : [ "SOAP_XML", "OMA_DM" ]
                            }
                        },
                        "osuServiceUrl" : {
                            "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})*)?$",
                            "description" : "External service URL, start with https://"
                        },
                        "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" : {
                                        "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" ],
                                        "description" : "Language of the friendly name"
                                    },
                                    "name" : {
                                        "description" : "Name of the friendly name",
                                        "type" : "string",
                                        "minLength" : 2,
                                        "maxLength" : 32
                                    },
                                    "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" ],
                    "description" : "External online singup, required when type is External"
                }
            },
            "required" : [ "type" ],
            "description" : "Online Signup & Provisioning"
        },
        "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/v5_1/profiles/hs20/identityproviders

Use this API command to create a new Hotspot 2.0 identity provider.

Request
HideShow
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" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the Hotspot 2.0 identity provider profile"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Hotspot 2.0 identity provider profile"
        },
        "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" : {
                        "type" : "string",
                        "maxLength" : 255,
                        "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                        "description" : "Authentication realm"
                    },
                    "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" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Online singup type",
                    "enum" : [ "Internal", "External" ]
                },
                "internalOSU" : {
                    "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" : {
                                    "type" : [ "object", "null" ],
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "id" : {
                                            "type" : "string"
                                        },
                                        "name" : {
                                            "type" : "string"
                                        }
                                    },
                                    "description" : "Internal online singup portal, required when type is Internal"
                                },
                                "externalUrl" : {
                                    "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})*)?$",
                                    "description" : "External online singup portal, start with https://, required when type is External"
                                }
                            },
                            "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" : {
                                        "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" ],
                                        "description" : "Language of the friendly name"
                                    },
                                    "name" : {
                                        "description" : "Name of the friendly name",
                                        "type" : "string",
                                        "minLength" : 2,
                                        "maxLength" : 32
                                    },
                                    "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" : {
                            "type" : [ "object", "null" ],
                            "additionalProperties" : false,
                            "properties" : {
                                "id" : {
                                    "type" : "string"
                                },
                                "name" : {
                                    "type" : "string"
                                }
                            },
                            "description" : "Online signup certificate"
                        },
                        "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" : {
                                        "type" : "string",
                                        "maxLength" : 255,
                                        "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                        "description" : "Authentication realm"
                                    },
                                    "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" ],
                    "description" : "Internal online singup, required when type is Internal"
                },
                "externalOSU" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "provisioningProtocals" : {
                            "description" : "Provisioning protocal",
                            "type" : "array",
                            "item" : {
                                "enum" : [ "SOAP_XML", "OMA_DM" ]
                            }
                        },
                        "osuServiceUrl" : {
                            "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})*)?$",
                            "description" : "External service URL, start with https://"
                        },
                        "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" : {
                                        "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" ],
                                        "description" : "Language of the friendly name"
                                    },
                                    "name" : {
                                        "description" : "Name of the friendly name",
                                        "type" : "string",
                                        "minLength" : 2,
                                        "maxLength" : 32
                                    },
                                    "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" ],
                    "description" : "External online singup, required when type is External"
                }
            },
            "required" : [ "type" ],
            "description" : "Online Signup & Provisioning"
        },
        "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"
        }
    }
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/profiles/hs20/identityproviders/{id}

Use this API command to modify the basic information of a Hotspot 2.0 identity provider.

Request
HideShow
Body
{
  "id": "1fb20eaf-7b9b-40c7-8b9b-7d69d6165176",
  "name": "hs20IdentithInternalOSU",
  "description": ""
}
Schema
{
  "id": {
    "description": "Identifier of the Hotspot 2.0 identity provider profile",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the Hotspot 2.0 identity provider profile"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the Hotspot 2.0 identity provider profile"
  },
  "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"
  }
}
Response  204

Modify Realms

PATCH/v5_1/profiles/hs20/identityproviders/{id}/realms

Use this API command to modify realms of a Hotspot 2.0 identity provider.

Request
HideShow
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"
    ]
  }
}
Response  204

Modify PLMNs

PATCH/v5_1/profiles/hs20/identityproviders/{id}/plmns

Use this API command to modify PLMNs of a Hotspot 2.0 identity provider.

Request
HideShow
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"
    ]
  }
}
Response  204

Modify Home OIs

PATCH/v5_1/profiles/hs20/identityproviders/{id}/homeOis

Use this API command to modify home OIs of a Hotspot 2.0 identity provider.

Request
HideShow
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"
    ]
  }
}
Response  204

Modify Authentications

PATCH/v5_1/profiles/hs20/identityproviders/{id}/authentications

Use this API command to modify authentications of a Hotspot 2.0 identity provider.

Request
HideShow
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": {
        "type": "string",
        "maxLength": 255,
        "pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
        "description": "Authentication realm"
      },
      "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"
    ]
  }
}
Response  204

Modify Accountings

PATCH/v5_1/profiles/hs20/identityproviders/{id}/accountings

Use this API command to modify accountings of a Hotspot 2.0 identity provider.

Request
HideShow
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"
    ]
  }
}
Response  204

Disable Accountings

DELETE/v5_1/profiles/hs20/identityproviders/{id}/accountings

Use this API command to disable accountings of a Hotspot 2.0 identity provider.

Response  204

Modify Online Signup & Provisioning

PATCH/v5_1/profiles/hs20/identityproviders/{id}/osu

Use this API command to modify online signup & provisioning of a Hotspot 2.0 identity provider.

Request
HideShow
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
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "type" : {
            "description" : "Online singup type",
            "enum" : [ "Internal", "External" ]
        },
        "internalOSU" : {
            "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" : {
                            "type" : [ "object", "null" ],
                            "additionalProperties" : false,
                            "properties" : {
                                "id" : {
                                    "type" : "string"
                                },
                                "name" : {
                                    "type" : "string"
                                }
                            },
                            "description" : "Internal online singup portal, required when type is Internal"
                        },
                        "externalUrl" : {
                            "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})*)?$",
                            "description" : "External online singup portal, start with https://, required when type is External"
                        }
                    },
                    "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" : {
                                "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" ],
                                "description" : "Language of the friendly name"
                            },
                            "name" : {
                                "description" : "Name of the friendly name",
                                "type" : "string",
                                "minLength" : 2,
                                "maxLength" : 32
                            },
                            "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" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Online signup certificate"
                },
                "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" : {
                                "type" : "string",
                                "maxLength" : 255,
                                "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                "description" : "Authentication realm"
                            },
                            "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" ],
            "description" : "Internal online singup, required when type is Internal"
        },
        "externalOSU" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "provisioningProtocals" : {
                    "description" : "Provisioning protocal",
                    "type" : "array",
                    "item" : {
                        "enum" : [ "SOAP_XML", "OMA_DM" ]
                    }
                },
                "osuServiceUrl" : {
                    "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})*)?$",
                    "description" : "External service URL, start with https://"
                },
                "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" : {
                                "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" ],
                                "description" : "Language of the friendly name"
                            },
                            "name" : {
                                "description" : "Name of the friendly name",
                                "type" : "string",
                                "minLength" : 2,
                                "maxLength" : 32
                            },
                            "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" ],
            "description" : "External online singup, required when type is External"
        }
    },
    "required" : [ "type" ],
    "description" : "Online Signup & Provisioning"
}
Response  204

Disable Online Signup & Provisioning

DELETE/v5_1/profiles/hs20/identityproviders/{id}/osu

Use this API command to disable online signup & provisioning of a Hotspot 2.0 identity provider.

Response  204

Delete

DELETE/v5_1/profiles/hs20/identityproviders/{id}

Use this API command to delete a Hotspot 2.0 identity provider.

Response  204

Delete

DELETE/v5_1/profiles/hs20/identityproviders

Use this API command to delete multiple Hotspot 2.0 identity provider.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Query hotspot 2.0 identity provider

POST/v5_1/profiles/hs20/identityproviders/query

Query hotspot 2.0 identity providers. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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" : {
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                        "description" : "Name of the Hotspot 2.0 identity provider profile"
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the Hotspot 2.0 identity provider profile"
                    },
                    "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" : {
                                    "type" : "string",
                                    "maxLength" : 255,
                                    "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                    "description" : "Authentication realm"
                                },
                                "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" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "type" : {
                                "description" : "Online singup type",
                                "enum" : [ "Internal", "External" ]
                            },
                            "internalOSU" : {
                                "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" : {
                                                "type" : [ "object", "null" ],
                                                "additionalProperties" : false,
                                                "properties" : {
                                                    "id" : {
                                                        "type" : "string"
                                                    },
                                                    "name" : {
                                                        "type" : "string"
                                                    }
                                                },
                                                "description" : "Internal online singup portal, required when type is Internal"
                                            },
                                            "externalUrl" : {
                                                "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})*)?$",
                                                "description" : "External online singup portal, start with https://, required when type is External"
                                            }
                                        },
                                        "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" : {
                                                    "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" ],
                                                    "description" : "Language of the friendly name"
                                                },
                                                "name" : {
                                                    "description" : "Name of the friendly name",
                                                    "type" : "string",
                                                    "minLength" : 2,
                                                    "maxLength" : 32
                                                },
                                                "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" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        },
                                        "description" : "Online signup certificate"
                                    },
                                    "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" : {
                                                    "type" : "string",
                                                    "maxLength" : 255,
                                                    "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                                    "description" : "Authentication realm"
                                                },
                                                "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" ],
                                "description" : "Internal online singup, required when type is Internal"
                            },
                            "externalOSU" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "provisioningProtocals" : {
                                        "description" : "Provisioning protocal",
                                        "type" : "array",
                                        "item" : {
                                            "enum" : [ "SOAP_XML", "OMA_DM" ]
                                        }
                                    },
                                    "osuServiceUrl" : {
                                        "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})*)?$",
                                        "description" : "External service URL, start with https://"
                                    },
                                    "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" : {
                                                    "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" ],
                                                    "description" : "Language of the friendly name"
                                                },
                                                "name" : {
                                                    "description" : "Name of the friendly name",
                                                    "type" : "string",
                                                    "minLength" : 2,
                                                    "maxLength" : 32
                                                },
                                                "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" ],
                                "description" : "External online singup, required when type is External"
                            }
                        },
                        "required" : [ "type" ],
                        "description" : "Online Signup & Provisioning"
                    },
                    "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/v5_1/certstore/certificate

Use this API command to retrieve list of installed certificates.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the certificate"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the certificate"
          }
        }
      }
    }
  }
}

Retrieve Certificate

GET/v5_1/certstore/certificate/{id}

Use this API command to retrieve an installed certificate.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the certificate"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the certificate"
    },
    "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": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "Certificates signing request of the certificate"
    },
    "passphrase": {
      "description": "Key passphrase",
      "type": "string"
    }
  }
}

Retrieve Certificate Setting

GET/v5_1/certstore/setting

Use this API command to retrieve certificate setting.

Response  200
HideShow
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": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "description": "certificate of the service"
          }
        },
        "required": [
          "service"
        ]
      }
    }
  }
}

Retrieve CSR List

GET/v5_1/certstore/csr

Use this API command to retrieve list of certificates signing request.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the certificates signing request"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the certificates signing request"
          }
        }
      }
    }
  }
}

Retrieve CSR

GET/v5_1/certstore/csr/{id}

Use this API command to retrieve a certificates signing request.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the certificates signing request"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the certificates signing request"
    },
    "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/v5_1/certstore/certificate

Use this API command to create an installed certificate.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the certificate"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the certificate"
    },
    "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": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "Certificates signing request of the certificate"
    },
    "passphrase": {
      "description": "Key passphrase",
      "type": "string"
    }
  },
  "required": [
    "name",
    "data"
  ]
}
Response  201
HideShow
Body
{
  "id": "certificateUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify serviceCertificates

PATCH/v5_1/certstore/setting/serviceCertificates

Use this API command to Modify serviceCertificates of the Certificate Setting.

Request
HideShow
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": {
        "type": [
          "object",
          "null"
        ],
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "description": "certificate of the service"
      }
    },
    "required": [
      "service"
    ]
  }
}
Response  204

Create CSR

POST/v5_1/certstore/csr

Use this API command to create a certificates signing request.

Request
HideShow
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" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the certificates signing request"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the certificates signing request"
        },
        "commonName" : {
            "type" : "string",
            "pattern" : "^(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}$",
            "description" : "Common name of the certificates signing request"
        },
        "email" : {
            "type" : "string",
            "pattern" : "^(\w+)([\-+.\'][\w]+)*@(\w[\-\w]*\.){1,255}([A-Za-z]){2,6}$",
            "description" : "Email of the certificates signing request"
        },
        "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" ]
}
Response  201
HideShow
Body
{
  "id": "certificateUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Delete Certificate

DELETE/v5_1/certstore/certificate/{id}

Use this API command to delete an installed certificate.

Response  204

Delete CSR

DELETE/v5_1/certstore/csr/{id}

Use this API command to delete a certificates signing request.

Response  204

Retrieve Trusted CA Chain Certificates List

GET/v5_1/certstore/trustedCAChainCert

Use this API command to retrieve list of installed trusted CA chain certificates.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
    "totalCount" : 2,
    "hasMore" : false,
    "firstIndex" : 0,
    "list" : [ {
        "id" : "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" : {
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                        "description" : "Name of the trusted CA chain certificate"
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the trusted CA chain certificate"
                    },
                    "modifierUsername" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Modifier user name of the trusted CA chain certificate"
                    },
                    "modifiedDateTime" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Modifier  of the trusted CA chain certificate"
                    },
                    "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/v5_1/certstore/trustedCAChainCert/{id}

Use this API command to retrieve an installed trusted CA chain certificates.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of  the trusted CA chain certificates"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the trusted CA chain certificates"
    },
    "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/v5_1/certstore/trustedCAChainCert

Use this API command to create trusted CA chain certificates.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the trusted CA chain certificates"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the trusted CA chain certificates"
    },
    "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"
  ]
}
Response  201
HideShow
Body
{
  "id": "certificateUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Delete Trusted CA Chain Certificates

DELETE/v5_1/certstore/trustedCAChainCert/{id}

Use this API command to delete a trusted CA chain certificate.

Response  204

Delete bulk Trusted CA Chain Certificates

DELETE/v5_1/certstore/trustedCAChainCert

Use this API command to delete bulk trusted CA chain certificates.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Patch Trusted CA Chain Certificates

PATCH/v5_1/certstore/trustedCAChainCert/{id}

Use this API command to patch a trusted CA chain certificates.

Request
HideShow
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-----",
    "rootCertData" : "rootCertificateData"
}
Schema
{
    "name" : {
        "type" : "string",
        "minLength" : 2,
        "maxLength" : 32,
        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
        "description" : "Name of the trusted CA chain certificates"
    },
    "description" : {
        "type" : [ "string", "null" ],
        "maxLength" : 64,
        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
        "description" : "Description of the trusted CA chain certificates"
    },
    "information" : {
        "description" : "Information of the certificates",
        "type" : "string"
    },
    "rootCertData" : {
        "description" : "Root data of the trusted CA chain certificates",
        "type" : "string"
    }
}
Response  204

AP APP

Retrieve Total AP Count

GET/v5_1/aps/totalCount

Use this API command to retrieve the total AP count within a zone or a domain.

URI Parameters
HideShow
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

Response  200
HideShow
Body
The total count (integer)

Retrieve AP Summary

GET/v5_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.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

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
boolean (optional) 

indicate to show alarm counter. Default: true

Response  200
HideShow
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" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "MAC address of the AP"
                    },
                    "name" : {
                        "description" : "Name of the AP",
                        "type" : "string"
                    },
                    "latitude" : {
                        "type" : "number",
                        "description" : "Latitude coordinate (in decimal format) of the AP"
                    },
                    "longitude" : {
                        "type" : "number",
                        "description" : "Longitude coordinate (in decimal format) of the AP"
                    },
                    "configState" : {
                        "description" : "State of the AP configuration",
                        "enum" : [ "newConfig", "fwApplied", "fwDownloaded", "fwFailed", "configApplied", "completed", "configFailed" ]
                    },
                    "location" : {
                        "type" : "string",
                        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Location of the AP. This is a free format text description that indicates the location of the AP."
                    },
                    "alarms" : {
                        "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"
                            }
                        },
                        "description" : "Alarm counters by severity on the AP"
                    }
                }
            }
        }
    }
}

Upload Workflow File

PUT/v5_1/lineman/workflow

Use this API command to upload a workflow file used by the Ruckus Wireless AP mobile app.

Request
HideShow
Body
The workflow file
Response  204

Download Workflow File

GET/v5_1/lineman/workflow

Use this API command to download the workflow file used by the Ruckus Wireless AP mobile app.

Response  200
HideShow
Body
The workflow file

Connectivity Tools

SpeedFlex

POST/v5_1/tool/speedflex

Use this API command to start the SpeedFlex test.

Request
HideShow
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" : {
            "type" : "string",
            "description" : "The HTTP request remove address is used if none is specified"
        },
        "clientMac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
            "description" : "The HTTP request remove MAC address is used if none is specified"
        },
        "serverIp" : {
            "type" : "string",
            "description" : "The AP IP address is resolved from the client IP address if none is specified"
        },
        "serverMac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
            "description" : "The AP MAC address is resolved from the client MAC address if none is specified"
        },
        "syspmtu" : {
            "description" : "Default: 1500",
            "type" : "integer"
        }
    },
    "required" : [ "tool", "protocol" ]
}
Response  200
HideShow
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/v5_1/tool/speedflex/{wcid}

Use this API command to retrieve existing SpeedFlex test results.

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

Use this API command to run the PING test on an AP.

URI Parameters
HideShow
apMac
string (required) 

MAC address of the AP running the PING test

targetIP
string (required) 

the IP address to PING

Response  200
HideShow
Body
PING Result

Trace Route

GET/v5_1/tool/traceRoute

Use this API command to run the traceroute test on an AP.

URI Parameters
HideShow
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)

Response  200
HideShow
Body
Trace Route Result

System

System Summary

GET/v5_1/controller

Use this API command to retrieve the system summary.

Response  200
HideShow
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",
      "dataIp": null
    }
  ]
}
Schema
{
  "additionalProperties": false,
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "list": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "apVersion": {
            "description": "AP version",
            "type": "string"
          },
          "clusterRole": {
            "description": "Indicator the role of the controller",
            "type": "string"
          },
          "controlIp": {
            "description": "Control IP",
            "type": "string"
          },
          "controlIpv6": {
            "description": "Control IPv6",
            "type": "string"
          },
          "controlNatIp": {
            "description": "Control NAT IP address settings",
            "type": "string"
          },
          "cpVersion": {
            "description": "Control plane version",
            "type": "string"
          },
          "dataIp": {
            "description": "Data IP",
            "type": "string"
          },
          "description": {
            "description": "Description of the controller",
            "type": "string"
          },
          "dpVersion": {
            "description": "Data plane version",
            "type": "string"
          },
          "hostName": {
            "description": "Host name of the controller",
            "type": "string"
          },
          "id": {
            "description": "Identifier of the controller",
            "type": "string"
          },
          "mac": {
            "description": "MAC address of the controller",
            "type": "string"
          },
          "model": {
            "description": "Product model",
            "type": "string"
          },
          "name": {
            "description": "Name of the controller",
            "type": "string"
          },
          "serialNumber": {
            "description": "Serial number of the controller",
            "type": "string"
          },
          "uptimeInSec": {
            "description": "Uptime (in seconds) of the controller",
            "type": "integer"
          },
          "version": {
            "description": "SCG version",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "totalCount": {
      "type": "integer"
    }
  },
  "type": "object"
}

AP Models

GET/v5_1/system/apmodels

Use this API command to retrieve AP models.

Response  200
HideShow
Body
List of AP Models (ex: ["ZF7782","ZF7762"])

System Statistics

GET/v5_1/controller/{id}/statistics

Use this API command to retrieve the system statistics.

URI Parameters
HideShow
interval
string (optional) 

Interval, only valid of (QUARTER, HOUR, DAY). Default: QUARTER

size
number (optional) 

Size, list size to response. Default: 32

Response  200
HideShow
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
    },
    "data": {
      "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
    },
    "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
    }
  }
]
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": {
        "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"
          }
        },
        "description": "port0"
      },
      "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"
          }
        },
        "description": "port1"
      },
      "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"
          }
        },
        "description": "port2"
      },
      "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"
          }
        },
        "description": "port3"
      },
      "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"
          }
        },
        "description": "control"
      },
      "data": {
        "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"
          }
        },
        "description": "data"
      }
    }
  }
}

System Inventory

GET/v5_1/system/inventory

Use this API command to retrieve the system inventory with current logon user domain.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
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"
    }
  }
}

Retrieve AP Auto Approve Policy

GET/v5_1/system/apSettings/approval

Retrieve AP Auto Approve Policy.

Response  200
HideShow
Body
{
  "approveEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "approveEnabled": {
      "description": "enable automatically approve all join requests from APs",
      "type": "boolean"
    }
  }
}

Modify AP Auto Approve Policy

PATCH/v5_1/system/apSettings/approval

Modify AP Auto Approve Policy.

Request
HideShow
Body
{
  "approveEnabled": true
}
Schema
{
  "approveEnabled": {
    "description": "enable automatically approve all join requests from APs",
    "type": "boolean"
  }
}
Response  204

Retrieve NBI

GET/v5_1/system/nbi

Use this API command to retrieve user information by Northbound Portal Interface.

URI Parameters
HideShow
domainId
string (optional) 
Response  200
HideShow
Body
{
  "userName": "admin",
  "password": "admin!234"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "userName" : {
            "type" : "string",
            "maxLength" : 64,
            "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
            "description" : "User name of the Northbound Interface"
        },
        "password" : {
            "type" : "string",
            "maxLength" : 64,
            "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
            "description" : "Password of the Northbound Interface"
        }
    }
}

Modify NBI Basic

PATCH/v5_1/system/nbi

Use this API command to modify the user information by Northbound Portal Interface.

URI Parameters
HideShow
domainId
string (optional) 
Request
HideShow
Body
{
  "userName": "admin",
  "password": "admin!234"
}
Schema
{
    "userName" : {
        "type" : "string",
        "maxLength" : 64,
        "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
        "description" : "User name of the Northbound Interface"
    },
    "password" : {
        "type" : "string",
        "maxLength" : 64,
        "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
        "description" : "Password of the Northbound Interface"
    }
}
Response  204

Disable NBI

DELETE/v5_1/system/nbi

Use this API command to disable the user information by Northbound Portal Interface.

URI Parameters
HideShow
domainId
string (optional) 
Response  204

Get AP recovery setting

GET/v5_1/system/ap_recovery

Use this API command to get system level ap recovery ssid information.

Response  200
HideShow
Body
{
  "recoverySsidEnable": true,
  "recoverySsidPskKey": "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/v5_1/system/ap_recovery

Use this API command to patch system level ap recovery ssid.

Request
HideShow
Body
{
  "recoverySsidEnable": true,
  "recoverySsidPskKey": "12345678"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "description": "enable AP recovery mode",
      "type": "boolean"
    },
    "rsm": {
      "description": "RSM key",
      "type": "string"
    }
  }
}
Response  204

Execute ap balance

POST/v5_1/system/ap_balance

Execute ap balance.

Response  200

FtpServerSettings

Add FTP server

POST/v5_1/ftps

Add FTP server.

Request
HideShow
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"
      ]
    }
  }
}
Response  201

Update FTP server

PATCH/v5_1/ftps/{ftpId}

Update FTP server settings.

Request
HideShow
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
{
  "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"
    ]
  }
}
Response  204

Remove FTP server

DELETE/v5_1/ftps/{ftpId}

Remove FTP server.

Response  204

Remove FTP servers

DELETE/v5_1/ftps

Remove FTP servers.

Request
HideShow
Body
{
  "idList": [
    "71d7b8a9-33ed-45e4-9140-7b2c31e5d6f5",
    "7c450388-8b67-4b01-b926-d71ec48b4d20"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

Retrieve FTP server list

POST/v5_1/ftps/query

Retrieve information of all FTP server. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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
{
  "additionalProperties": false,
  "properties": {
    "extra": {
      "description": "extra information for ftp",
      "type": "string"
    },
    "firstIndex": {
      "description": "Index of the first FTP returned out of the complete FTP list",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more FTPs after the list that is currently displayed",
      "type": "boolean"
    },
    "list": {
      "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"
            ]
          }
        }
      },
      "type": "array"
    },
    "totalCount": {
      "description": "Total FTP count",
      "type": "integer"
    }
  },
  "type": "object"
}

Retrieve FTP server information

GET/v5_1/ftps/{ftpId}

Retrieve information of specific FTP server.

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

Test ftp server of specific FTP server settings.

Request
HideShow
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"
      ]
    }
  }
}
Response  200
HideShow
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/v5_1/ftps/test/{ftpId}

Test ftp server of specific FTP server id.

Response  200
HideShow
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"
    }
  }
}

Wireless Client

Retrieve Total Client Count

GET/v5_1/aps/{apMac}/operational/client/totalCount

Use this API command to retrieve the total client count per AP.

Response  200
HideShow
Body
The total count (integer)

Retrieve Client List

GET/v5_1/aps/{apMac}/operational/client

Use this API command to retrieve the client list per AP.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 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",
      "rssi": "33",
      "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" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "MAC of the Client"
                    },
                    "ipAddress" : {
                        "type" : "string",
                        "description" : "IP address of the Client"
                    },
                    "ipv6Address" : {
                        "type" : "string",
                        "description" : "IP V6 address of the Client"
                    },
                    "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"
                    },
                    "rssi" : {
                        "description" : "RSSI",
                        "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"
                    },
                    "apRxSignal" : {
                        "description" : "AP Rx signal",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Deauth client

POST/v5_1/clients/deauth

Use this API command to deauth client.

Request
HideShow
Body
{
  "mac": "E8:99:C4:AD:7C:38",
  "apMac": "C0:8A:DE:24:FA:00"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "mac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
            "description" : "Client Mac"
        },
        "apMac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
            "description" : "AP Mac"
        }
    },
    "required" : [ "mac", "apMac" ]
}
Response  204

Bulk deauth client

POST/v5_1/clients/bulkDeauth

Use this API command to bulk deauth client.

Request
HideShow
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" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "Client Mac"
                    },
                    "apMac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "AP Mac"
                    }
                },
                "required" : [ "mac", "apMac" ]
            },
            "minItems" : 1,
            "uniqueItems" : true
        }
    }
}
Response  204

Disconnect client

POST/v5_1/clients/disconnect

Use this API command to disconnect client.

Request
HideShow
Body
{
  "mac": "E8:99:C4:AD:7C:38",
  "apMac": "C0:8A:DE:24:FA:00"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "mac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
            "description" : "Client Mac"
        },
        "apMac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
            "description" : "AP Mac"
        }
    },
    "required" : [ "mac", "apMac" ]
}
Response  204

Bulk disconnect client

POST/v5_1/clients/bulkDisconnect

Use this API command to bulk disconnect client.

Request
HideShow
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" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "Client Mac"
                    },
                    "apMac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "AP Mac"
                    }
                },
                "required" : [ "mac", "apMac" ]
            },
            "minItems" : 1,
            "uniqueItems" : true
        }
    }
}
Response  204

Historical client

POST/v5_1/query/historicalclient

Use this API command to retrive historical client. Please click the link for the usage of Query Cirteria.

Request
HideShow
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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for historical client"
    },
    "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/v5_1/clients/byWlanName/{wlanname}

Use this API command to query client by wlan name.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for client list"
    },
    "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"
          }
        }
      }
    }
  }
}

Application Visibility Control

User Defined Retrieve List

POST/v5_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.

Request
HideShow
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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for user defined policy"
    },
    "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": "Domain Id",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the User Defined Profile"
          },
          "type": {
            "description": "Type of the User Defined Profile",
            "enum": [
              "IP_WITH_PORT",
              "PORT_ONLY"
            ]
          },
          "destIp": {
            "type": "string",
            "description": "Server IP"
          },
          "netmask": {
            "type": "string",
            "pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)",
            "description": "netmask of User Defined Profile"
          },
          "destPort": {
            "description": "destPort 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/v5_1/avc/userDefined/{id}

Use this API command to retrieve a AVC User Defined profile.

Response  200
HideShow
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": "Domain Id",
      "type": "string"
    },
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the User Defined Profile"
    },
    "type": {
      "description": "Type of the User Defined Profile",
      "enum": [
        "IP_WITH_PORT",
        "PORT_ONLY"
      ]
    },
    "destIp": {
      "type": "string",
      "description": "Server IP"
    },
    "netmask": {
      "type": "string",
      "pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)",
      "description": "netmask of User Defined Profile"
    },
    "destPort": {
      "description": "destPort 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/v5_1/avc/userDefined

Use this API command to create a new AVC User Defined profile.

Request
HideShow
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": "Domain Id",
      "type": "string"
    },
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the User Defined Profile"
    },
    "type": {
      "description": "Type of the User Defined Profile",
      "enum": [
        "IP_WITH_PORT",
        "PORT_ONLY"
      ]
    },
    "destIp": {
      "type": "string",
      "description": "Server IP"
    },
    "netmask": {
      "type": "string",
      "pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)",
      "description": "netmask of User Defined Profile"
    },
    "destPort": {
      "description": "destPort 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"
  ]
}
Response  201
HideShow
Body
{
  "id": "acc29c30-ee35-11e4-8c03-000c292547b9"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

User Defined Modify Basic

PATCH/v5_1/avc/userDefined/{id}

Use this API command to modify the basic information on AVC User Defined profile.

Request
HideShow
Body
{
  "name": "test-modify",
  "destIp": "11.22.33.44",
  "netmask": "255.255.255.0",
  "destPort": 11,
  "protocol": "UDP"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the User Defined Profile"
  },
  "type": {
    "description": "Type of the User Defined Profile",
    "enum": [
      "IP_WITH_PORT",
      "PORT_ONLY"
    ]
  },
  "destIp": {
    "type": "string",
    "description": "Server IP"
  },
  "netmask": {
    "type": "string",
    "pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)",
    "description": "netmask of User Defined Profile"
  },
  "destPort": {
    "description": "destPort of User Defined Profile",
    "type": "integer",
    "minimum": 1,
    "maximum": 65535
  },
  "protocol": {
    "description": "protocol of User Defined Profile",
    "enum": [
      "TCP",
      "UDP"
    ]
  }
}
Response  204

User Defined Delete

DELETE/v5_1/avc/userDefined/{id}

Use this API command to delete a AVC User Defined Profile.

Response  204

User Defined Multiple Delete

DELETE/v5_1/avc/userDefined

Use this API command to delete a AVC User Defined Profile.

Request
HideShow
Body
{
  "idList": [
    "acc29c30-ee35-11e4-8c03-000c292547b9",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Application Policy Retrieve List

POST/v5_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.

Request
HideShow
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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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"
        }
      ]
    },
    {
      "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"
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for application policy"
    },
    "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": "Domain Id",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the Application Policy Profile"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the Application Policy Profile"
          },
          "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"
                  ]
                }
              }
            }
          },
          "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/v5_1/avc/applicationPolicy/{id}

Use this API command to retrieve a AVC Application Policy profile.

Response  200
HideShow
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"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the Application Policy Profile",
      "type": "string"
    },
    "tenantId": {
      "description": "Tenant Id",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the Application Policy Profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the Application Policy Profile"
    },
    "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"
            ]
          }
        }
      }
    },
    "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/v5_1/avc/applicationPolicy

Use this API command to create a new AVC Application Policy profile.

Request
HideShow
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
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the Application Policy Profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the Application Policy Profile"
    },
    "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"
            ]
          }
        }
      }
    }
  },
  "required": [
    "name",
    "applicationRules"
  ]
}
Response  201
HideShow
Body
{
  "id": "acc29c30-ee35-11e4-8c03-000c292547b9"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Application Policy Modify Basic

PATCH/v5_1/avc/applicationPolicy/{id}

Use this API command to modify the basic information on AVC Application Policy profile.

Request
HideShow
Body
{
  "name": "aa",
  "description": ""
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the Application Policy Profile"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the Application Policy Profile"
  }
}
Response  204

Application Policy Modify applicationRules

PATCH/v5_1/avc/applicationPolicy/{id}/applicationRules

Use this API command to modify the applicationRules information on AVC Application Policy profile.

Request
HideShow
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"
        ]
      }
    }
  }
}
Response  204

Application Policy Delete

DELETE/v5_1/avc/applicationPolicy/{id}

Use this API command to delete a AVC Application Policy Profile.

Response  204

Application Policy Multiple Delete

DELETE/v5_1/avc/applicationPolicy

Use this API command to delete a AVC Application Policy Profile.

Request
HideShow
Body
{
  "idList": [
    "acc29c30-ee35-11e4-8c03-000c292547b9",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

Upload File

POST/v5_1/avc/signaturePackage/upload

Update AVC Signature Package by upload file.

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

Get current Signature Package info.

Response  200
HideShow
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/v5_1/avc/signaturePackage/categories

Get Application Category list from current Signature Package.

Response  200
HideShow
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/v5_1/avc/signaturePackage/applications

Get Application list from current Signature Package.

Response  200
HideShow
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/v5_1/avc/signaturePackage/category/{categoryName}

Get Application Category info (catId and name) by category name.

Response  200
HideShow
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/v5_1/avc/signaturePackage/application/{applicationName}

Get Application info (catId, appId and name) by application name.

Response  200
HideShow
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"
    }
  }
}

Configuration backup and restore

System configuration backup

POST/v5_1/configuration/backup

Backup system configuration.

Response  201
HideShow
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/v5_1/configuration/restore/{id}

Restore system configuration with specified backupUUID.

Response  204

Retrieve List

GET/v5_1/configuration

Retrive system configuration list.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "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"
          }
        }
      }
    }
  }
}

Get Auto Export Backup

GET/v5_1/configurationSettings/autoExportBackup

Get Auto Export Backup Settings.

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

Get Schedule Backup Setting.

Response  200
HideShow
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"
    }
  }
}

Delete

DELETE/v5_1/configuration/{id}

Delete system configuration file.

Response  204

Modify Auto Export Backup

PATCH/v5_1/configurationSettings/autoExportBackup

Modify Auto Export Backup Settings.

Request
HideShow
Body
{
  "enableAutoExportBackup": true,
  "ftpServer": "FTP server name"
}
Schema
{
  "enableAutoExportBackup": {
    "description": "enable auto export backup",
    "type": "boolean",
    "default": false
  },
  "ftpServer": {
    "description": "ftp server name",
    "type": "string"
  }
}
Response  204

Modify Schedule Backup Setting

PATCH/v5_1/configurationSettings/scheduleBackup

Modify Schedule Backup Setting.

Request
HideShow
Body
{
  "enableScheduleBackup": true,
  "interval": "WEEKLY",
  "dayOfWeek": "MONDAY",
  "hour": 2,
  "minute": 15
}
Schema
{
  "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
  }
}
Response  204

Upload

POST/v5_1/configuration/upload

Upload system configuration file.

Response  204

Download

GET/v5_1/configuration/download

Download system configuration file.

URI Parameters
HideShow
backupUUID
string (required) 

System configuration file uuid

timeZone
string (optional) 

DEPRECATED Time zone

Response  200

Syslog Server

Retrieve Syslog

GET/v5_1/system/syslog

Retrieve syslog server setting.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "enabled": true,
  "appLogFacility": "Local1",
  "appLogSeverity": "Debug",
  "auditLogFacility": "Local2",
  "auditLogSeverity": "Debug",
  "eventLogFacility": "Local2",
  "otherLogSeverity": "Debug",
  "forwardUEEventsMsgFormatType": "COMMON",
  "primaryServer": {
    "host": "192.1.0.1",
    "port": 90
  },
  "secondaryServer": {
    "host": "192.10.8.9",
    "port": 82,
    "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": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "host": {
          "description": "address of the syslog server.",
          "type": "string"
        },
        "port": {
          "description": "port number of the syslog server",
          "type": "integer"
        }
      },
      "description": "The primary server settings of syslog server"
    },
    "secondaryServer": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "host": {
          "description": "address of the syslog server.",
          "type": "string"
        },
        "port": {
          "description": "port number of the syslog server",
          "type": "integer"
        },
        "redundancyMode": {
          "description": "The redundancy mode of syslog server",
          "enum": [
            "active_active",
            "primary_backup"
          ]
        }
      },
      "description": "The secondary server settings of syslog server"
    },
    "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"
          ]
        }
      },
      "description": "Priority"
    }
  }
}

Modify Syslog

PATCH/v5_1/system/syslog

Modify syslog server setting.

Request
HideShow
Body
{
  "enabled": true,
  "appLogFacility": "Local1",
  "auditLogFacility": "Local2",
  "eventLogFacility": "Local2",
  "appLogSeverity": "Debug",
  "auditLogSeverity": "Debug",
  "otherLogSeverity": "Debug",
  "forwardUEEventsMsgFormatType": "COMMON"
}
Schema
{
  "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"
  }
}
Response  204

Modify Primary Server

PATCH/v5_1/system/syslog/primaryServer

Modify Primary Server of syslog.

Request
HideShow
Body
{
  "host": "192.1.0.1",
  "port": 90
}
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"
    }
  },
  "description": "The primary server settings of syslog server"
}
Response  204

Modify Secondary Server

PATCH/v5_1/system/syslog/secondaryServer

Modify Secondary Server of syslog.

Request
HideShow
Body
{
  "host": "192.10.8.9",
  "port": 82,
  "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"
    },
    "redundancyMode": {
      "description": "The redundancy mode of syslog server",
      "enum": [
        "active_active",
        "primary_backup"
      ]
    }
  },
  "description": "The secondary server settings of syslog server"
}
Response  204

Modify Priority

PATCH/v5_1/system/syslog/priority

Modify Priority of syslog.

Request
HideShow
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"
      ]
    }
  },
  "description": "Priority"
}
Response  204

AP Usb Software Package

Retrieve List

GET/v5_1/rkszones/{zoneId}/usbsoftware

Retrieve a list of AP Usb Software Package.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "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/v5_1/rkszones/{zoneId}/usbsoftware

Create new AP Usb Software Package by upload file.

Response  201
HideShow
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/v5_1/rkszones/{zoneId}/usbsoftware/{id}

Delete specified AP Usb Software Package.

Response  204

GET Zone Associate

GET/v5_1/rkszones/{zoneId}/usbsoftware/{modelName}

Get APUsbSoftwarePackage associate with zone by model name.

Response  200
HideShow
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/v5_1/rkszones/{zoneId}/apgroups/{id}/usbsoftware/{modelName}

Get APUsbSoftwarePackage associate with APGroup by model name.

Response  200
HideShow
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/v5_1/aps/{apMac}/usbsoftware

Get APUsbSoftwarePackage associate AP by model name.

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

Retrieve a list of L2 Access Control.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the service"
          }
        }
      }
    }
  }
}

Retrieve

GET/v5_1/rkszones/{zoneId}/l2ACL/{id}

Retrieve an L2 Access Control.

Response  200
HideShow
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" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "name of the L2 Access Control "
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "description of the L2 Access Control "
        },
        "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])|(\d+)$"
            }
        }
    }
}

Create L2 Access Control

POST/v5_1/rkszones/{zoneId}/l2ACL

Create a new L2 Access Control.

Request
HideShow
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" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "name of the L2 Access Control "
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "description of the L2 Access Control "
        },
        "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])|(\d+)$"
            }
        }
    },
    "required" : [ "name", "restriction" ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the created portal profile",
      "type": "string"
    }
  }
}

Modify Basic

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

Modify a specific L2 Access Control basic.

Request
HideShow
Body
{
  "name": "l2acl_modify_name",
  "description": "l2acl_modify_desc",
  "restriction": "BLOCK"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "name of the L2 Access Control "
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "description of the L2 Access Control "
  },
  "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"
    ]
  }
}
Response  204

Modify Rule Macs

PATCH/v5_1/rkszones/{zoneId}/l2ACL/{id}/ruleMacs

Modify a specific L2 Access Control Rule Macs.

Request
HideShow
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])|(\d+)$"
    }
}
Response  204

Delete

DELETE/v5_1/rkszones/{zoneId}/l2ACL/{id}

Delete an L2 Access Control.

Response  204

Block Client

Create Block Client

POST/v5_1/blockClient/{zoneId}

Create a new Block Client.

Request
HideShow
Body
{
  "mac": "AA:BB:CC:DD:EE:FF",
  "description": ""
}
Schema
{
    "type" : "object",
    "properties" : {
        "mac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
            "description" : "MAC of the Block Client"
        },
        "zoneId" : {
            "description" : "Zone Id of the Block Client for clone in System Domain",
            "type" : "string"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Block Client"
        },
        "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" ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create Block Client by AP MAC

POST/v5_1/blockClient/byApMac/{apMac}

Create a new Block Client by AP MAC.

Request
HideShow
Body
{
  "mac": "AA:BB:CC:DD:EE:FF",
  "description": ""
}
Schema
{
    "type" : "object",
    "properties" : {
        "mac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
            "description" : "MAC of the Block Client"
        },
        "zoneId" : {
            "description" : "Zone Id of the Block Client for clone in System Domain",
            "type" : "string"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Block Client"
        },
        "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" ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create Block Clients

POST/v5_1/blockClient

Create new Block Clients by list.

Request
HideShow
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": {
        "allOf": [
          {
            "$ref": "#/blockClient"
          },
          {
            "properties": {
              "apMac": {
                "description": "MAC of the AP",
                "$ref": "common.json#/mac"
              }
            },
            "required": [
              "apMac"
            ]
          }
        ]
      }
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the Block Client"
    }
  }
}
Response  201
HideShow
Body
[
  {
    "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "id": {
        "type": "string"
      }
    }
  }
}

Retrieve List

POST/v5_1/blockClient/query

Retrieve a list of Block Client. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "MAC of the Block Client"
                    },
                    "zoneId" : {
                        "description" : "Zone Id of the Block Client for clone in System Domain",
                        "type" : "string"
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the Block Client"
                    },
                    "modifiedDateTime" : {
                        "description" : "Date blocked of the Block Client",
                        "type" : "integer"
                    },
                    "modifierUsername" : {
                        "description" : "Modifier blocked of the Block Client",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Retrieve List

GET/v5_1/blockClient/byZone/{zoneId}

Retrieve a list of Block Client.

Response  200
HideShow
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" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "MAC of the Block Client"
                    },
                    "zoneId" : {
                        "description" : "Zone Id of the Block Client for clone in System Domain",
                        "type" : "string"
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the Block Client"
                    },
                    "modifiedDateTime" : {
                        "description" : "Date blocked of the Block Client",
                        "type" : "integer"
                    },
                    "modifierUsername" : {
                        "description" : "Modifier blocked of the Block Client",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Retrieve

GET/v5_1/blockClient/{id}

Retrieve a Block Client.

Response  200
HideShow
Body
{
  "mac": "AA:BB:CC:DD:EE:FF",
  "description": ""
}
Schema
{
    "type" : "object",
    "properties" : {
        "mac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
            "description" : "MAC of the Block Client"
        },
        "zoneId" : {
            "description" : "Zone Id of the Block Client for clone in System Domain",
            "type" : "string"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Block Client"
        },
        "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 Basic

PUT/v5_1/blockClient/{id}

Modify a specific Block Client basic.

Request
HideShow
Body
{
  "mac": "AA:BB:CC:DD:EE:FF",
  "description": "des"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "mac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
            "description" : "MAC of the Block Client"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Block Client"
        }
    }
}
Response  204

Modify Basic

PATCH/v5_1/blockClient/{id}

Modify a specific Block Client basic.

Request
HideShow
Body
{
  "mac": "AA:BB:CC:DD:EE:FF",
  "description": "des"
}
Schema
{
    "mac" : {
        "type" : "string",
        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
        "description" : "MAC of the Block Client"
    },
    "description" : {
        "type" : [ "string", "null" ],
        "maxLength" : 64,
        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
        "description" : "Description of the Block Client"
    }
}
Response  204

Delete

DELETE/v5_1/blockClient/{id}

Delete a Block Client.

Response  204

Delete

DELETE/v5_1/blockClient

Delete Block Client List.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Mark Rogue

Mark Known Rogue

POST/v5_1/rogue/markKnown

Mark a rogue AP as know.

Request
HideShow
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])|(\d+)$"
            }
        }
    }
}
Response  204

Unmark Rogue

POST/v5_1/rogue/unMark

Unmark a rogue AP.

Request
HideShow
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])|(\d+)$"
            }
        }
    }
}
Response  204

Get known Rogue

GET/v5_1/rogue/markKnown

Get Known Rogue AP list.

Response  200
HideShow
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])|(\d+)$"
            }
        }
    }
}

Ethernet Port Profile

Retrieve List - Ethernet Port Porfile

GET/v5_1/rkszones/{zoneId}/profile/ethernetPort

Retrieve a list of Ethernet Port Porfiles within a zone.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the service"
          }
        }
      }
    }
  }
}

Retrieve - Ethernet Port Porfile

GET/v5_1/rkszones/{zoneId}/profile/ethernetPort/{id}

Retrieve a Ethernet Port Porfile.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "name of the ethernet port profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "description of the ethernet port profile"
    },
    "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": {
      "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": {
              "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"
      ],
      "description": "VLAN 802.1X of the ethernet port profile"
    }
  }
}

Create - Ethernet Port Porfile

POST/v5_1/rkszones/{zoneId}/profile/ethernetPort

Create a new Ethernet Port Porfile.

Request
HideShow
Body
{
  "name": "ethport",
  "description": "ethportDesc",
  "type": "AccessPort",
  "tunnelEnabled": true,
  "_8021X": {
    "type": "Disable",
    "authenticator": null,
    "supplicant": null
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "name of the ethernet port profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "description of the ethernet port profile"
    },
    "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": {
      "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": {
              "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"
      ],
      "description": "VLAN 802.1X of the ethernet port profile"
    }
  },
  "required": [
    "name",
    "type",
    "_8021X"
  ]
}
Response  201
HideShow
Body
{
  "id": "2"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the create object",
      "type": "string"
    }
  }
}

Modify - Ethernet Port Porfile

PATCH/v5_1/rkszones/{zoneId}/profile/ethernetPort/{id}

Modify a specific Ethernet Port Porfile.

Request
HideShow
Body
{
  "name": "modify-ethport",
  "description": "modify-ethport",
  "tunnelEnabled": null,
  "untagId": 1,
  "vlanMembers": "1-4094",
  "dynamicVlanEnabled": false,
  "guestVlan": null
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "name of the ethernet port profile"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "description of the ethernet port profile"
  },
  "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
  }
}
Response  204

Modify - _8021X of Ethernet Port Porfile

PATCH/v5_1/rkszones/{zoneId}/profile/ethernetPort/{id}/_8021X

Modify _8021X of Ethernet Port Porfile.

Request
HideShow
Body
{
  "type": "Supplicant",
  "authenticator": null,
  "supplicant": {
    "type": "Custom",
    "userName": "testuser",
    "password": "testpassword"
  }
}
Schema
{
  "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": {
          "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"
  ],
  "description": "VLAN 802.1X of the ethernet port profile"
}
Response  204

Delete - Ethernet Port Porfile

DELETE/v5_1/rkszones/{zoneId}/profile/ethernetPort/{id}

Delete Ethernet Port Porfile.

Response  204

Device Policy

Retrieve List - Device Policy Porfile

GET/v5_1/rkszones/{zoneId}/devicePolicy

Retrieve a list of Device Policy Porfiles within a zone.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the service"
          }
        }
      }
    }
  }
}

Retrieve - Device Policy Porfile

GET/v5_1/rkszones/{zoneId}/devicePolicy/{id}

Retrieve a Device Policy Porfile.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "name of the device policy cofig"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "description of the device policy cofig"
    },
    "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": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "description of the device policy rule"
          },
          "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/v5_1/rkszones/{zoneId}/devicePolicy

Create a new Device Policy Porfile.

Request
HideShow
Body
{
  "name": "devicepolic",
  "description": "devicepolicDesc",
  "defaultAction": "ALLOW"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "name of the device policy cofig"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "description of the device policy cofig"
    },
    "defaultAction": {
      "description": "defaultAction of the device policy cofig",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    }
  },
  "required": [
    "name",
    "defaultAction"
  ]
}
Response  201
HideShow
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/v5_1/rkszones/{zoneId}/devicePolicy/{id}

Modify a specific Device Policy Porfile.

Request
HideShow
Body
{
  "name": "devicepolic",
  "description": "devicepolicDesc",
  "defaultAction": "ALLOW"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "name of the device policy cofig"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "description of the device policy cofig"
  },
  "defaultAction": {
    "description": "defaultAction of the device policy cofig",
    "enum": [
      "ALLOW",
      "BLOCK"
    ]
  }
}
Response  204

Modify - Rule of Device Policy Porfile

PATCH/v5_1/rkszones/{zoneId}/devicePolicy/{id}/rule

Modify Rule of Device Policy Porfile.

Request
HideShow
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": {
        "type": [
          "string",
          "null"
        ],
        "maxLength": 64,
        "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
        "description": "description of the device policy rule"
      },
      "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"
        ]
      }
    }
  }
}
Response  204

Delete - Device Policy Porfile

DELETE/v5_1/rkszones/{zoneId}/devicePolicy/{id}

Delete Device Policy Porfile.

Response  204

VlanPooling

Retrieve List

POST/v5_1/vlanpoolings/query

Use this API command to retrieve a list of VLAN poolings. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "OR",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "sortInfo": {
    "sortColumn": "name",
    "dir": "ASC"
  },
  "page": 0,
  "start": 0,
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for User Traffic profile"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the service",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the service"
          },
          "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/v5_1/vlanpoolings/{id}

Use this API command to retrieve VLAN pooling.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the VLAN pooling profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the VLAN pooling profile"
    },
    "pool": {
      "description": "VLANs of the VLAN pooling profile",
      "type": "string"
    },
    "algo": {
      "description": "Algorithm of the VLAN pooling profile",
      "enum": [
        "MAC_HASH"
      ]
    }
  }
}

Create

POST/v5_1/vlanpoolings

Use this API command to create new VLAN pooling.

Request
HideShow
Body
{
  "name": "vlan pooling-test",
  "description": "create description",
  "pool": "3,12-18",
  "algo": "MAC_HASH"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the VLAN pooling profile"
    },
    "domainId": {
      "description": "identifier of the domain",
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the VLAN pooling profile"
    },
    "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"
  ]
}
Response  201
HideShow
Body
{
  "id": "ffbcfde0-e9bf-11e6-b761-64006a6a50c6"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the created portal profile",
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/vlanpoolings/{id}

Use this API command to modify the basic information on VLAN pooling.

Request
HideShow
Body
{
  "name": "VlanPooling",
  "description": "modify basic configuration",
  "pool": "20-26",
  "algo": "MAC_HASH"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the VLAN pooling profile"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the VLAN pooling profile"
  },
  "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"
  }
}
Response  204

Delete

DELETE/v5_1/vlanpoolings/{id}

Use this API command to delete VLAN pooling.

Response  204

Bulk Delete Vlan Pooling

DELETE/v5_1/vlanpoolings

Use this API command to bulk delete VLAN pooling.

Request
HideShow
Body
{
  "idList": [
    "d18e44e0-8af5-11e4-8155-000c299b4765",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Wechat

Retrieve List

GET/v5_1/rkszones/{zoneId}/portals/wechat

Use this API command to retrieve a list of wechat portal.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the service"
          }
        }
      }
    }
  }
}

Retrieve

GET/v5_1/rkszones/{zoneId}/portals/wechat/{id}

Use this API command to retrieve wechat portal by ID.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the wechat profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the wechat profile"
    },
    "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/v5_1/rkszones/{zoneId}/portals/wechat

Use this API command to create wechat portal.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the wechat profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the wechat profile"
    },
    "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"
  ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the created portal profile",
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/rkszones/{zoneId}/portals/wechat/{id}

Use this API command to modify the basic information of wechat portal.

Request
HideShow
Body
{
  "name": "wechat_modify_name",
  "description": "wechat_modify_desc",
  "authUrl": "http://www.ruckuswireless.com",
  "dnatDestination": "ruckus",
  "gracePeriod": 60,
  "blackList": "172.15.20.80"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the wechat profile"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the wechat profile"
  },
  "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"
  }
}
Response  204

Modify DNAT Port Mapping

PATCH/v5_1/rkszones/{zoneId}/portals/wechat/{id}/dnatPortMapping

Use this API command to modify DNAT port mapping of a wechat portal.

Request
HideShow
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
      }
    }
  }
}
Response  204

Modify whiteList

PATCH/v5_1/rkszones/{zoneId}/portals/wechat/{id}/whiteList

Use this API command to modify whiteList of a wechat portal.

Request
HideShow
Body
[
  "10.1.2.3",
  "10.9.0.5"
]
Schema
{
  "description": "White list of the wechat profile",
  "type": "array",
  "items": {
    "type": "string"
  }
}
Response  204

Delete

DELETE/v5_1/rkszones/{zoneId}/portals/wechat/{id}

Use this API command to delete wechat portal.

Response  204

Identity User Role

Retrieve List

GET/v5_1/identity/userrole

Use this API command to retrieve a list of identity user role.

Response  200
HideShow
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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for Identity roles"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the service",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the service"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "description"
          },
          "userTrafficProfile": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "description": "User traffic profile"
          },
          "maxDevices": {
            "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
              }
            },
            "description": "max Devices"
          },
          "vlanId": {
            "description": "vlan id",
            "type": "integer"
          },
          "vlanPooling": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "description": "VLAN pooling profile"
          },
          "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/v5_1/identity/userRoleList

Use this API command to retrieve a list of identity user role.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for Identity roles"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the service",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the service"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "description"
          },
          "userTrafficProfile": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "description": "User traffic profile"
          },
          "maxDevices": {
            "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
              }
            },
            "description": "max Devices"
          },
          "vlanId": {
            "description": "vlan id",
            "type": "integer"
          },
          "vlanPooling": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "description": "VLAN pooling profile"
          },
          "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/v5_1/identity/userrole/{id}

Use this API command to retrieve identity user role by ID.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "name"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "description"
    },
    "userTrafficProfile": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "User traffic profile"
    },
    "maxDevices": {
      "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
        }
      },
      "description": "max Devices"
    },
    "vlanId": {
      "description": "vlan id",
      "type": "integer"
    },
    "vlanPooling": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "VLAN pooling profile"
    },
    "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/v5_1/identity/userrole

Use this API command to create identity user role.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
      "description": "name"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "description"
    },
    "userTrafficProfile": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "User traffic profile"
    },
    "maxDevices": {
      "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
        }
      },
      "description": "max Devices"
    },
    "vlanId": {
      "description": "vlan id",
      "type": "integer"
    },
    "vlanPooling": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "VLAN pooling profile"
    }
  },
  "required": [
    "name",
    "userTrafficProfile",
    "maxDevices"
  ]
}
Response  201
HideShow
Body
{
  "id": "e5db11b3-71ff-4234-80d0-c7562e9868af"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the create object",
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/identity/userrole/{id}

Use this API command to modify the basic information of identity user role.

Request
HideShow
Body
{
  "name": "modify-userrole-test",
  "description": "modify user role test",
  "vlanId": 2
}
Schema
{
  "id": {
    "description": "ID",
    "type": "string"
  },
  "domainId": {
    "description": "Domain Id",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 64,
    "pattern": "^[!-~]([ -~]){0,62}[!-~]$",
    "description": "name"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "description"
  },
  "vlanId": {
    "description": "vlan id",
    "type": "integer"
  }
}
Response  204

Modify max device

PATCH/v5_1/identity/userrole/{id}/maxDevices

Use this API command to modify max device allowed of identity user role.

Request
HideShow
Body
{
  "maxDevicesAllowed": "LIMITED",
  "maxDevicesNumber": 3
}
Schema
{
  "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
    }
  },
  "description": "max Devices"
}
Response  204

Modify user traffic profile

PATCH/v5_1/identity/userrole/{id}/userTrafficProfile

Use this API command to modify user traffic profile of identity user role.

Request
HideShow
Body
{
  "name": "userTrafficProfileName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "User traffic profile"
}
Response  204

Modify VLAN pooling

PATCH/v5_1/identity/userrole/{id}/vlanPooling

Use this API command to modify VLAN pooling of identity user role.

Request
HideShow
Body
{
  "name": "vlanPooling"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "VLAN pooling profile"
}
Response  204

Delete

DELETE/v5_1/identity/userrole/{id}

Use this API command to delete identity user role.

Response  204

Delete Multiple Identity User Roles

DELETE/v5_1/identity/userrole

Use this API command to delete multiple identity user roles.

Request
HideShow
Body
{
  "idList": [
    "b5f02dbf-c769-436d-ae2d-44a6af194b57",
    "839f87c6-d116-497e-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

AP Registration Rules

Retrieve List

GET/v5_1/apRules

Use this API command to retrieve a list of AP Registration Rules profile.

Response  200
HideShow
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": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the AP Registration Rules"
          }
        }
      }
    }
  }
}

Retrieve

GET/v5_1/apRules/{id}

Use this API command to retrieve AP Registration Rules profile by ID.

Response  200
HideShow
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": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the AP Registration Rules"
    },
    "type": {
      "description": "type of the AP Registration Rules",
      "enum": [
        "IPAddressRange",
        "Subnet",
        "GPSCoordinates",
        "ProvisionTag"
      ]
    },
    "ipAddressRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "fromIp": {
          "type": "string",
          "description": "from IP Address"
        },
        "toIp": {
          "type": "string",
          "description": "to IP Address"
        }
      },
      "description": "IPAddressRange of the AP Registration Rules"
    },
    "subnet": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "networkAddress": {
          "type": "string",
          "description": "networkAddress"
        },
        "subnetMask": {
          "description": "subnetMask",
          "type": "string"
        }
      },
      "description": "Subnet of the AP Registration Rules"
    },
    "gpsCoordinates": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "latitude": {
          "type": "number",
          "description": "latitude"
        },
        "longitude": {
          "type": "number",
          "description": "longitude"
        },
        "distance": {
          "description": "distance",
          "type": "number"
        }
      },
      "description": "GPSCoordinates of the AP Registration Rules"
    },
    "provisionTag": {
      "description": "ProvisionTag of the AP Registration Rules",
      "pattern": "^[!-~]([!-~]){0,31}$"
    },
    "mobilityZone": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "mobilityZone of the AP Registration Rules"
    }
  }
}

Create

POST/v5_1/apRules

Use this API command to create AP Registration Rules profile.

Request
HideShow
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": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the AP Registration Rules"
    },
    "type": {
      "description": "type of the AP Registration Rules",
      "enum": [
        "IPAddressRange",
        "Subnet",
        "GPSCoordinates",
        "ProvisionTag"
      ]
    },
    "ipAddressRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "fromIp": {
          "type": "string",
          "description": "from IP Address"
        },
        "toIp": {
          "type": "string",
          "description": "to IP Address"
        }
      },
      "description": "IPAddressRange of the AP Registration Rules"
    },
    "subnet": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "networkAddress": {
          "type": "string",
          "description": "networkAddress"
        },
        "subnetMask": {
          "description": "subnetMask",
          "type": "string"
        }
      },
      "description": "Subnet of the AP Registration Rules"
    },
    "gpsCoordinates": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "latitude": {
          "type": "number",
          "description": "latitude"
        },
        "longitude": {
          "type": "number",
          "description": "longitude"
        },
        "distance": {
          "description": "distance",
          "type": "number"
        }
      },
      "description": "GPSCoordinates of the AP Registration Rules"
    },
    "provisionTag": {
      "description": "ProvisionTag of the AP Registration Rules",
      "pattern": "^[!-~]([!-~]){0,31}$"
    },
    "mobilityZone": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "mobilityZone of the AP Registration Rules"
    }
  },
  "required": [
    "type",
    "mobilityZone"
  ]
}
Response  201
HideShow
Body
{
  "id": "f031d790-f2dd-11e4-b4f9-000c292547b9"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/apRules/{id}

Use this API command to modify the basic information of AP Registration Rules profile.

Request
HideShow
Body
{
  "description": "postman_aprule",
  "type": "Subnet",
  "provisionTag": "provisiontag"
}
Schema
{
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the AP Registration Rules"
  },
  "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}$"
  }
}
Response  204

Modify IP Address Range

PATCH/v5_1/apRules/{id}/ipAddressRange

Use this API command to modify IP Address Range of a AP Registration Rules profile.

Request
HideShow
Body
{
  "fromIp": "11.11.11.11",
  "toIp": "11.11.11.13"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "fromIp": {
      "type": "string",
      "description": "from IP Address"
    },
    "toIp": {
      "type": "string",
      "description": "to IP Address"
    }
  },
  "description": "IPAddressRange of the AP Registration Rules"
}
Response  204

Modify Subnet

PATCH/v5_1/apRules/{id}/subnet

Use this API command to modify subnet of AP Registration Rules profile.

Request
HideShow
Body
{
  "networkAddress": "11.11.11.11",
  "subnetMask": "255.255.0.0"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "networkAddress": {
      "type": "string",
      "description": "networkAddress"
    },
    "subnetMask": {
      "description": "subnetMask",
      "type": "string"
    }
  },
  "description": "Subnet of the AP Registration Rules"
}
Response  204

Modify GPSCoordinates

PATCH/v5_1/apRules/{id}/gpsCoordinates

Use this API command to modify GPSCoordinates of AP Registration Rules profile.

Request
HideShow
Body
{
  "latitude": 50.11,
  "longitude": 100.533,
  "distance": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "latitude": {
      "type": "number",
      "description": "latitude"
    },
    "longitude": {
      "type": "number",
      "description": "longitude"
    },
    "distance": {
      "description": "distance",
      "type": "number"
    }
  },
  "description": "GPSCoordinates of the AP Registration Rules"
}
Response  204

Modify mobilityZone

PATCH/v5_1/apRules/{id}/mobilityZone

Use this API command to modify mobilityZone of AP Registration Rules profile.

Request
HideShow
Body
{
  "id": "1690614e-1c1f-4fe8-9144-24ccf28d83c4"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "mobilityZone of the AP Registration Rules"
}
Response  204

Delete

DELETE/v5_1/apRules/{id}

Use this API command to delete AP Registration Rules profile.

Response  204

move priority up

GET/v5_1/apRules/priorityUp/{id}

Use this API command to move Priority Up of AP Registration Rules profile.

Response  204

move priority down

GET/v5_1/apRules/priorityDown/{id}

Use this API command to move Priority Down of AP Registration Rules profile.

Response  204

Data Plane

Retrieve List

GET/v5_1/enterprise/planes

Use this API command to retrieve a list of data planes.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "clusterNode": "JSZML-289",
      "description": "api test",
      "model": "SZ104",
      "serialNumber": "00004567",
      "numOfAPs": 0,
      "macAddress": "00:00:0C:43:24:00",
      "mntCtrlIp": "10.2.9.174",
      "apTunnelIp": "172.17.60.86",
      "dpStatus": "Managed",
      "clusterRole": "Leader",
      "uptime": "1.0d 20.0h 28.0m "
    }
  ]
}
Schema
{
  "additionalProperties": false,
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "list": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "apTunnelIp": {
            "description": "AP Tunnel Data IP address",
            "type": "string"
          },
          "clusterNode": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the data plane"
          },
          "clusterRole": {
            "description": "Managed By",
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the data plane"
          },
          "dpStatus": {
            "description": "Status",
            "type": "string"
          },
          "id": {
            "description": "Identifier of data plane",
            "type": "string"
          },
          "macAddress": {
            "description": "DP MAC Address",
            "type": "string"
          },
          "mntCtrlIp": {
            "description": "Management and AP Control IP address",
            "type": "string"
          },
          "model": {
            "description": "Model",
            "type": "string"
          },
          "numOfAPs": {
            "description": "Total Connected APs",
            "type": "integer"
          },
          "serialNumber": {
            "description": "Serial Number",
            "type": "string"
          },
          "uptime": {
            "description": "Uptime",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "totalCount": {
      "type": "integer"
    }
  },
  "type": "object"
}

Retrieve

GET/v5_1/enterprise/planes/{bladeUUID}

Use this API command to retrieve data plane by bladeUUID.

Response  200
HideShow
Body
{
  "managementAPControl": {
    "ipMode": "STATIC",
    "ipAddress": "10.2.9.174",
    "subnetMask": "255.255.0.0",
    "gateway": "10.2.0.1",
    "natIp": ""
  },
  "apTunnelData": {
    "ipMode": "STATIC",
    "ipAddress": "172.17.60.86",
    "subnetMask": "255.255.254.0",
    "gateway": "172.17.60.1",
    "natIp": ""
  },
  "dnsServer": {
    "primaryDNSServer": "172.17.17.16",
    "secondaryDNSServer": ""
  }
}
Schema
{
  "additionalProperties": false,
  "properties": {
    "apTunnelData": {
      "additionalProperties": false,
      "properties": {
        "gateway": {
          "description": "Gateway",
          "type": "string"
        },
        "ipAddress": {
          "description": "IP address",
          "type": "string"
        },
        "ipMode": {
          "description": "IP mode",
          "enum": [
            "STATIC",
            "DHCP"
          ]
        },
        "natIp": {
          "description": "Data NAT IP",
          "type": "string"
        },
        "subnetMask": {
          "description": "Subnet Mask",
          "type": "string"
        }
      },
      "type": "object",
      "description": "AP tunnel data"
    },
    "dnsServer": {
      "additionalProperties": false,
      "properties": {
        "primaryDNSServer": {
          "description": "Primary DNS Server",
          "type": "string"
        },
        "secondaryDNSServer": {
          "description": "Secondary DNS Server",
          "type": "string"
        }
      },
      "type": "object",
      "description": "DNS server"
    },
    "managementAPControl": {
      "additionalProperties": false,
      "properties": {
        "gateway": {
          "description": "Gateway",
          "type": "string"
        },
        "ipAddress": {
          "description": "IP address",
          "type": "string"
        },
        "ipMode": {
          "description": "IP mode",
          "enum": [
            "STATIC",
            "DHCP"
          ]
        },
        "natIp": {
          "description": "Control NAT IP",
          "type": "string"
        },
        "subnetMask": {
          "description": "Subnet mask",
          "type": "string"
        }
      },
      "type": "object",
      "description": "Management and AP Control"
    }
  },
  "type": "object"
}

Modify management and AP control

PATCH/v5_1/enterprise/planes/{bladeUUID}/managementAPControl

Use this API command to modify management and AP control of data plane. It may take 5 to 10 minutes to restart the network and controller services.

Request
HideShow
Body
{
  "ipMode": "STATIC",
  "ipAddress": "10.2.9.174",
  "subnetMask": "255.255.0.0",
  "gateway": "10.2.0.1"
}
Schema
{
  "additionalProperties": false,
  "properties": {
    "gateway": {
      "description": "Gateway",
      "type": "string"
    },
    "ipAddress": {
      "description": "IP address",
      "type": "string"
    },
    "ipMode": {
      "description": "IP mode",
      "enum": [
        "STATIC",
        "DHCP"
      ]
    },
    "natIp": {
      "description": "Control NAT IP",
      "type": "string"
    },
    "subnetMask": {
      "description": "Subnet mask",
      "type": "string"
    }
  },
  "type": "object",
  "description": "Management and AP Control"
}
Response  204

Modify AP tunnel data

PATCH/v5_1/enterprise/planes/{bladeUUID}/apTunnelData

Use this API command to modify AP tunnel data of data plane. It may take 5 to 10 minutes to restart the network and controller services.

Request
HideShow
Body
{
  "ipMode": "STATIC",
  "ipAddress": "172.17.60.86",
  "subnetMask": "255.255.254.0",
  "gateway": "172.17.60.1"
}
Schema
{
  "additionalProperties": false,
  "properties": {
    "gateway": {
      "description": "Gateway",
      "type": "string"
    },
    "ipAddress": {
      "description": "IP address",
      "type": "string"
    },
    "ipMode": {
      "description": "IP mode",
      "enum": [
        "STATIC",
        "DHCP"
      ]
    },
    "natIp": {
      "description": "Data NAT IP",
      "type": "string"
    },
    "subnetMask": {
      "description": "Subnet Mask",
      "type": "string"
    }
  },
  "type": "object",
  "description": "AP tunnel data"
}
Response  204

Modify IPv4 DNS server

PATCH/v5_1/enterprise/planes/{bladeUUID}/dnsServer

Use this API command to modify IPv4 DNS server of data plane. It may take 5 to 10 minutes to restart the network and controller services.

Request
HideShow
Body
{
  "primaryDNSServer": "172.17.17.16"
}
Schema
{
  "additionalProperties": false,
  "properties": {
    "primaryDNSServer": {
      "description": "Primary DNS Server",
      "type": "string"
    },
    "secondaryDNSServer": {
      "description": "Secondary DNS Server",
      "type": "string"
    }
  },
  "type": "object",
  "description": "DNS server"
}
Response  204

Modify Static Route

PATCH/v5_1/enterprise/planes/{bladeUUID}/staticRoute

Use this API command to modify static route of data plane. It may take 5 to 10 minutes to restart the network and controller services.

Request
HideShow
Body
[
  {
    "networkAddress": "10.2.2.0",
    "subnetMask": "255.255.254.0",
    "gateway": "10.2.2.254",
    "interfaceType": "DATA",
    "metric": 0
  }
]
Schema
{
  "description": "Static route",
  "items": {
    "additionalProperties": false,
    "properties": {
      "gateway": {
        "description": "Gateway",
        "type": "string"
      },
      "interfaceType": {
        "description": "Interface type",
        "enum": [
          "MANAGEMENT",
          "DATA"
        ]
      },
      "metric": {
        "description": "Metric",
        "type": "integer"
      },
      "networkAddress": {
        "description": "Network address",
        "type": "string"
      },
      "subnetMask": {
        "description": "Subnet mask",
        "type": "string"
      }
    },
    "required": [
      "gateway",
      "interfaceType",
      "networkAddress",
      "subnetMask"
    ],
    "type": "object"
  },
  "type": "array"
}
Response  200

Modify User Defined Interface

PATCH/v5_1/enterprise/planes/{bladeUUID}/userDefinedInterface

Use this API command to modify user defined interface. It may take 5 to 10 minutes to restart the network and controller services.

Request
HideShow
Body
[
  {
    "name": "interface-name",
    "physicalInterface": "CONTROL_INTERFACE",
    "service": "NOT_SPECIFIED",
    "ipAddress": "2.2.2.2",
    "subnetMask": "255.255.255.0",
    "vlan": "11"
  },
  {
    "name": "interface-name",
    "physicalInterface": "CONTROL_INTERFACE",
    "service": "NOT_SPECIFIED",
    "ipAddress": "8.8.8.8",
    "subnetMask": "255.255.255.0",
    "vlan": "221"
  }
]
Schema
{
  "description": "User Defined Interface",
  "items": {
    "additionalProperties": false,
    "properties": {
      "ipAddress": {
        "description": "IP Address",
        "type": "string"
      },
      "name": {
        "description": "Name",
        "type": "string"
      },
      "physicalInterface": {
        "description": "Physical interface",
        "enum": [
          "CONTROL_INTERFACE"
        ]
      },
      "service": {
        "description": "Service",
        "enum": [
          "HOTSPOT",
          "NOT_SPECIFIED"
        ]
      },
      "subnetMask": {
        "description": "Subnet Mask",
        "type": "string"
      },
      "vlan": {
        "description": "VLAN",
        "type": "string"
      }
    },
    "required": [
      "name",
      "physicalInterface",
      "service",
      "ipAddress",
      "subnetMask",
      "vlan"
    ],
    "type": "object"
  },
  "type": "array"
}
Response  200

RuckusGRE Tunnel Profile

Retrieve List

GET/v5_1/profiles/tunnel/ruckusgre

Use this API command to retrieve a list of RuckusGRE tunnel profile.

Response  200
HideShow
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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for profile"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the profile"
          }
        }
      }
    },
    "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/v5_1/profiles/tunnel/ruckusgre/{id}

Use this API command to retrieve RuckusGRE tunnel profile.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "name of the RuckusGRE profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "description of the RuckusGRE profile"
    },
    "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/v5_1/profiles/tunnel/ruckusgre

Use this API command to create RuckusGRE tunnel profile.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "name of the RuckusGRE profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "description of the RuckusGRE profile"
    },
    "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"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/profiles/tunnel/ruckusgre/{id}

Use this API command to modify the basic information of RuckusGRE tunnel profile.

Request
HideShow
Body
{
  "name": "RuckusGRE tunnel profile name",
  "description": "RuckusGRE tunnel profile description",
  "tunnelMode": "GRE",
  "enableTunnelEncryption": false,
  "tunnelMtuAutoEnabled": "MANUAL",
  "tunnelMtuSize": 1500
}
Schema
{
  "id": {
    "description": "Profile Id",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "name of the RuckusGRE profile"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "description of the RuckusGRE profile"
  },
  "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"
  }
}
Response  204

Delete

DELETE/v5_1/profiles/tunnel/ruckusgre/{id}

Use this API command to delete RuckusGRE tunnel profile.

Response  204

Delete

DELETE/v5_1/profiles/tunnel/ruckusgre

Use this API command to delete multiple RuckusGRE tunnel profile.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Query List

POST/v5_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.

Request
HideShow
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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "name of the RuckusGRE profile"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "description of the RuckusGRE profile"
          },
          "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/v5_1/profiles/tunnel/softgre

Use this API command to retrieve a list of SoftGRE tunnel profile.

Response  200
HideShow
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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for profile"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the profile"
          }
        }
      }
    },
    "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/v5_1/profiles/tunnel/softgre/{id}

Use this API command to retrieve SoftGRE tunnel profile.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "name of the SoftGRE profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "description of the SoftGRE profile"
    },
    "ipMode": {
      "enum": [
        "IPV4",
        "IPV6",
        "IPV4_IPV6"
      ],
      "description": "Gateway IP Mode of SoftGRE profile"
    },
    "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/v5_1/profiles/tunnel/softgre

Use this API command to create SoftGRE tunnel profile.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "name of the SoftGRE profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "description of the SoftGRE profile"
    },
    "ipMode": {
      "enum": [
        "IPV4",
        "IPV6",
        "IPV4_IPV6"
      ],
      "description": "Gateway IP Mode of SoftGRE profile"
    },
    "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"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/profiles/tunnel/softgre/{id}

Use this API command to modify the basic information of SoftGRE tunnel profile.

Request
HideShow
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
{
  "id": {
    "description": "Profile Id",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "name of the SoftGRE profile"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "description of the SoftGRE profile"
  },
  "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"
  }
}
Response  204

Delete

DELETE/v5_1/profiles/tunnel/softgre/{id}

Use this API command to delete SoftGRE tunnel profile.

Response  204

Delete

DELETE/v5_1/profiles/tunnel/softgre

Use this API command to delete multiple SoftGRE tunnel profile.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Query List

POST/v5_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.

Request
HideShow
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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "name of the SoftGRE profile"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "description of the SoftGRE profile"
          },
          "ipMode": {
            "enum": [
              "IPV4",
              "IPV6",
              "IPV4_IPV6"
            ],
            "description": "Gateway IP Mode of SoftGRE profile"
          },
          "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"
            }
          }
        }
      }
    }
  }
}

Cluster backup and restore

Cluster backup

POST/v5_1/cluster/backup

Backup cluster.

Response  204

Cluster restore

POST/v5_1/cluster/restore/{id:.+}

Restore cluster backup by ID.

Response  204

Retrieve List

GET/v5_1/cluster

Retrive cluster backup list.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

timezone
string (optional) 

Change display timezone of created date and time, like timezone=Asia/Taipei, default is UTC time.

Response  200
HideShow
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"
          }
        }
      }
    }
  }
}

Delete

DELETE/v5_1/cluster/{id:.+}

Delete cluster backup by ID.

Response  204

System Upgrade

Upload File

POST/v5_1/upgrade/upload

Use this API command to upload patch file.

Response  200
HideShow
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": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "operation": {
          "description": "operation of clusterOperationProgress",
          "enum": [
            "None",
            "Join",
            "Backup",
            "Restore",
            "Upload",
            "Upgrade",
            "BackupAndUpgrade",
            "RemoveBlade",
            "ChangeBladeIP",
            "DiskSnapshot",
            "UploadVDPFirmware"
          ]
        },
        "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": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "operation": {
              "description": "operation of previousOperationRecord",
              "enum": [
                "None",
                "Join",
                "Backup",
                "Restore",
                "Upload",
                "Upgrade",
                "BackupAndUpgrade",
                "RemoveBlade",
                "ChangeBladeIP",
                "DiskSnapshot",
                "UploadVDPFirmware"
              ]
            },
            "success": {
              "description": "success of previousOperationRecord",
              "type": "boolean"
            },
            "errorMsg": {
              "description": "errorMsg of previousOperationRecord",
              "type": "string"
            }
          },
          "description": "previousOperationRecord of clusterOperationProgress"
        },
        "clusterSubTaskState": {
          "description": "clusterSubTaskState of clusterOperationProgress",
          "enum": [
            "None",
            "Running",
            "Failed",
            "Completed"
          ]
        },
        "clusterOperationBlockUI": {
          "description": "clusterOperationBlockUI of clusterOperationProgress",
          "type": "boolean"
        },
        "clusterOperationDisplayMsg": {
          "description": "clusterOperationDisplayMsg of clusterOperationProgress",
          "type": "string"
        }
      },
      "description": "upgrade status"
    }
  }
}

Retrive Cluster Progress Status

GET/v5_1/upgrade/status

Use this API command to retrive cluster progress status.

Response  200
HideShow
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": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "operation": {
          "description": "operation of clusterOperationProgress",
          "enum": [
            "None",
            "Join",
            "Backup",
            "Restore",
            "Upload",
            "Upgrade",
            "BackupAndUpgrade",
            "RemoveBlade",
            "ChangeBladeIP",
            "DiskSnapshot",
            "UploadVDPFirmware"
          ]
        },
        "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": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "operation": {
              "description": "operation of previousOperationRecord",
              "enum": [
                "None",
                "Join",
                "Backup",
                "Restore",
                "Upload",
                "Upgrade",
                "BackupAndUpgrade",
                "RemoveBlade",
                "ChangeBladeIP",
                "DiskSnapshot",
                "UploadVDPFirmware"
              ]
            },
            "success": {
              "description": "success of previousOperationRecord",
              "type": "boolean"
            },
            "errorMsg": {
              "description": "errorMsg of previousOperationRecord",
              "type": "string"
            }
          },
          "description": "previousOperationRecord of clusterOperationProgress"
        },
        "clusterSubTaskState": {
          "description": "clusterSubTaskState of clusterOperationProgress",
          "enum": [
            "None",
            "Running",
            "Failed",
            "Completed"
          ]
        },
        "clusterOperationBlockUI": {
          "description": "clusterOperationBlockUI of clusterOperationProgress",
          "type": "boolean"
        },
        "clusterOperationDisplayMsg": {
          "description": "clusterOperationDisplayMsg of clusterOperationProgress",
          "type": "string"
        }
      },
      "description": "upgrade status"
    }
  }
}

Retrive Upload Patch Info

GET/v5_1/upgrade/patch

Use this API command to retrive upload file Info.

Response  200
HideShow
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": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "operation": {
          "description": "operation of clusterOperationProgress",
          "enum": [
            "None",
            "Join",
            "Backup",
            "Restore",
            "Upload",
            "Upgrade",
            "BackupAndUpgrade",
            "RemoveBlade",
            "ChangeBladeIP",
            "DiskSnapshot",
            "UploadVDPFirmware"
          ]
        },
        "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": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "operation": {
              "description": "operation of previousOperationRecord",
              "enum": [
                "None",
                "Join",
                "Backup",
                "Restore",
                "Upload",
                "Upgrade",
                "BackupAndUpgrade",
                "RemoveBlade",
                "ChangeBladeIP",
                "DiskSnapshot",
                "UploadVDPFirmware"
              ]
            },
            "success": {
              "description": "success of previousOperationRecord",
              "type": "boolean"
            },
            "errorMsg": {
              "description": "errorMsg of previousOperationRecord",
              "type": "string"
            }
          },
          "description": "previousOperationRecord of clusterOperationProgress"
        },
        "clusterSubTaskState": {
          "description": "clusterSubTaskState of clusterOperationProgress",
          "enum": [
            "None",
            "Running",
            "Failed",
            "Completed"
          ]
        },
        "clusterOperationBlockUI": {
          "description": "clusterOperationBlockUI of clusterOperationProgress",
          "type": "boolean"
        },
        "clusterOperationDisplayMsg": {
          "description": "clusterOperationDisplayMsg of clusterOperationProgress",
          "type": "string"
        }
      },
      "description": "upgrade status"
    },
    "uploadPatchInfo": {
      "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"
          }
        }
      },
      "description": "upgrade patch info"
    }
  }
}

System Upgrade

POST/v5_1/upgrade

Use this API command to do system upgrade.

Response  200
HideShow
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": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "operation": {
          "description": "operation of clusterOperationProgress",
          "enum": [
            "None",
            "Join",
            "Backup",
            "Restore",
            "Upload",
            "Upgrade",
            "BackupAndUpgrade",
            "RemoveBlade",
            "ChangeBladeIP",
            "DiskSnapshot",
            "UploadVDPFirmware"
          ]
        },
        "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": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "operation": {
              "description": "operation of previousOperationRecord",
              "enum": [
                "None",
                "Join",
                "Backup",
                "Restore",
                "Upload",
                "Upgrade",
                "BackupAndUpgrade",
                "RemoveBlade",
                "ChangeBladeIP",
                "DiskSnapshot",
                "UploadVDPFirmware"
              ]
            },
            "success": {
              "description": "success of previousOperationRecord",
              "type": "boolean"
            },
            "errorMsg": {
              "description": "errorMsg of previousOperationRecord",
              "type": "string"
            }
          },
          "description": "previousOperationRecord of clusterOperationProgress"
        },
        "clusterSubTaskState": {
          "description": "clusterSubTaskState of clusterOperationProgress",
          "enum": [
            "None",
            "Running",
            "Failed",
            "Completed"
          ]
        },
        "clusterOperationBlockUI": {
          "description": "clusterOperationBlockUI of clusterOperationProgress",
          "type": "boolean"
        },
        "clusterOperationDisplayMsg": {
          "description": "clusterOperationDisplayMsg of clusterOperationProgress",
          "type": "string"
        }
      },
      "description": "upgrade status"
    }
  }
}

Retrive Upgrade History

GET/v5_1/upgrade/history

Use this API command to retrive upgrade history.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

timezone
string (optional) 
Response  200
HideShow
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"
          }
        }
      }
    }
  }
}

Application Log And Status

Retrieve List

GET/v5_1/applications/{bladeUUID}

Use this API command to retrieve a list of application log and status.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 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.

Response  200
HideShow
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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of control plane"
          }
        }
      }
    }
  }
}

Modify Log Level

PATCH/v5_1/applications

Use this API command to modify log level of specified application.

Request
HideShow
Body
{
  "applicationName": "API",
  "logLevel": "WARN"
}
Schema
{
  "applicationName": {
    "description": "Application name.",
    "type": "string"
  },
  "logLevel": {
    "description": "Log level.",
    "enum": [
      "DEBUG",
      "INFO",
      "WARN",
      "ERROR"
    ]
  }
}
Response  204

Download log

GET/v5_1/applications/download/{bladeUUID}

Use this API command to download logs of the application.

URI Parameters
HideShow
appName
string (required) 

Download all logs of the specified application name.

logFileName
string (optional) 

Download log of the specified log file name.

Response  200

Download snapshot log

GET/v5_1/applications/downloadsnap/{bladeUUID}

Use this API command to download snapshot logs.

Response  200

LWAPP TO SCG

Modify Basic

PATCH/v5_1/lwapp2scg

Use this API command to modify the basic information of the Lwapp Config.

Request
HideShow
Body
{
  "policy": "ACCEPT",
  "pasvMaxPort": 65000,
  "pasvMinPort": 16384,
  "natIpTranslation": true
}
Schema
{
  "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
  },
  "natIpTranslation": {
    "description": "natIpTranslation of the lwapp",
    "type": "boolean"
  }
}
Response  204

Modify ApList

PATCH/v5_1/lwapp2scg/apList

Use this API command to modify the apList of the Lwapp Config.

Request
HideShow
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"
  }
}
Response  204

Identity User

Retrieve Identity User List

GET/v5_1/identity/users

Use this API command to retrieve a list of identity user.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

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.

email
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.

Response  200
HideShow
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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for identity user"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the identity user",
            "type": "string"
          },
          "displayName": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Display name"
          },
          "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/v5_1/identity/userList

Use this API command to retrieve a list of identity user.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for identity user"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the identity user",
            "type": "string"
          },
          "displayName": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Display name"
          },
          "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/v5_1/identity/users/aaaserver

Use this API command to retrieve a list of aaa server.

Response  200
HideShow
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": {
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "the identifier of the AAA server",
            "type": "string"
          },
          "name": {
            "description": "the identifier of the AAA server",
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  }
}

Retrieve Package List

GET/v5_1/identity/users/packages

Use this API command to retrieve a list of packages.

Response  200
HideShow
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": {
        "additionalProperties": false,
        "properties": {
          "packageExpiration": {
            "description": "Package expiration interval and value",
            "type": "string"
          },
          "subscriberPackage": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "description": "Subscriber package"
          }
        },
        "type": "object"
      }
    }
  }
}

Retrieve Country List

GET/v5_1/identity/users/countries

Use this API command to retrieve a list of countries.

Response  200
HideShow
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": {
        "additionalProperties": false,
        "properties": {
          "countryName": {
            "description": "Full name of country",
            "type": "string"
          },
          "countryShortName": {
            "description": "Short name of country",
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  }
}

Retrieve

GET/v5_1/identity/users/{id}

Use this API command to retrieve identity user.

Response  200
HideShow
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": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "Subscriber package"
    },
    "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": {
      "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": {
          "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"
              ]
            }
          },
          "description": "Server configuration"
        },
        "passwordCreation": {
          "description": "Creation Date of Password",
          "type": "string"
        },
        "passwordExpiration": {
          "description": "Expiration Date of Password",
          "type": "string"
        }
      },
      "description": ""
    },
    "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/v5_1/identity/users

Use this API command to create identity user.

Request
HideShow
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": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "Subscriber package"
    }
  },
  "required": [
    "firstName",
    "lastName",
    "isDisabled",
    "userName",
    "password"
  ]
}
Response  201
HideShow
Body
{
  "id": "e5db11b3-71ff-4234-80d0-c7562e9868af"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the create object",
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/identity/users/{id}

Use this API command to modify the basic information of identity user.

Request
HideShow
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",
  "password": "password"
}
Schema
{
  "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"
  }
}
Response  204

Modify Subscriber Package

PATCH/v5_1/identity/users/{id}/subscriberPackage

Use this API command to modify subscriber package.

Request
HideShow
Body
{
  "id": "f482f1ce-d7a7-4c55-b582-0ae3eccd4489"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Subscriber package"
}
Response  204

Delete

DELETE/v5_1/identity/users/{id}

Use this API command to delete identity user.

Response  204

Delete Multiple Identity Users

DELETE/v5_1/identity/users

Use this API command to delete multiple identity users.

Request
HideShow
Body
{
  "idList": [
    "b5f02dbf-c769-436d-ae2d-44a6af194b57",
    "839f87c6-d116-497e-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Identity Guest Pass

Retrieve Identity Guest Pass List

GET/v5_1/identity/guestpass

Use this API command to retrieve a list of identity guest pass.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

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.

Response  200
HideShow
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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for GuestPass"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Guest name of the identity guest pass"
          },
          "wlan": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "description": "wlan"
          },
          "zone": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "description": "zone"
          },
          "ssid": {
            "description": "SSID",
            "type": "string"
          },
          "passValidFor": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "expirationValue": {
                "type": "integer"
              },
              "expirationUnit": {
                "enum": [
                  "HOUR",
                  "DAY",
                  "WEEK"
                ]
              }
            },
            "description": "Pass valid for"
          },
          "maxDevices": {
            "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
              }
            },
            "description": "max Devices"
          },
          "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": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "requireLoginAgain": {
                "type": "boolean"
              },
              "sessionValue": {
                "type": "integer"
              },
              "sessionUnit": {
                "enum": [
                  "MIN",
                  "HOUR",
                  "DAY",
                  "WEEK"
                ]
              }
            },
            "description": "session duration"
          },
          "domainId": {
            "description": "identifier of the domain",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve Identity Guest Pass List

POST/v5_1/identity/guestpassList

Use this API command to retrieve a list of identity guest pass.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for GuestPass"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Guest name of the identity guest pass"
          },
          "wlan": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "description": "wlan"
          },
          "zone": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "description": "zone"
          },
          "ssid": {
            "description": "SSID",
            "type": "string"
          },
          "passValidFor": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "expirationValue": {
                "type": "integer"
              },
              "expirationUnit": {
                "enum": [
                  "HOUR",
                  "DAY",
                  "WEEK"
                ]
              }
            },
            "description": "Pass valid for"
          },
          "maxDevices": {
            "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
              }
            },
            "description": "max Devices"
          },
          "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": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "requireLoginAgain": {
                "type": "boolean"
              },
              "sessionValue": {
                "type": "integer"
              },
              "sessionUnit": {
                "enum": [
                  "MIN",
                  "HOUR",
                  "DAY",
                  "WEEK"
                ]
              }
            },
            "description": "session duration"
          },
          "domainId": {
            "description": "identifier of the domain",
            "type": "string"
          }
        }
      }
    }
  }
}

Generate Identity Guest Pass

POST/v5_1/identity/guestpass/generate

Use this API command to generate identity guest pass.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Guest name"
    },
    "wlan": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "wlan id"
    },
    "zone": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "zone id"
    },
    "numberOfPasses": {
      "description": "Number of passes",
      "type": "integer"
    },
    "passValidFor": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "expirationValue": {
          "type": "integer"
        },
        "expirationUnit": {
          "enum": [
            "HOUR",
            "DAY",
            "WEEK"
          ]
        }
      },
      "description": "Pass valid for"
    },
    "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": {
      "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
        }
      },
      "description": "max Devices"
    },
    "sessionDuration": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "requireLoginAgain": {
          "type": "boolean"
        },
        "sessionValue": {
          "type": "integer"
        },
        "sessionUnit": {
          "enum": [
            "MIN",
            "HOUR",
            "DAY",
            "WEEK"
          ]
        }
      },
      "description": "session duration"
    },
    "remarks": {
      "description": "Remarks",
      "type": "string"
    }
  },
  "required": [
    "guestName",
    "wlan",
    "zone",
    "numberOfPasses",
    "passValidFor",
    "maxDevices"
  ]
}
Response  201
HideShow
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/v5_1/identity/guestpass/upload

Use this API command to upload identity guest pass csv file.

Response  200

Common Identity Guest Pass Settings

POST/v5_1/identity/guestpass/upload/common

Use this API command to update common identity guest pass settings.

Request
HideShow
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": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "wlan id"
    },
    "zone": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "zone id"
    },
    "passValidFor": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "expirationValue": {
          "type": "integer"
        },
        "expirationUnit": {
          "enum": [
            "HOUR",
            "DAY",
            "WEEK"
          ]
        }
      },
      "description": "Pass valid for"
    },
    "passEffectSince": {
      "description": "Pass effective since",
      "enum": [
        "CREATION_TIME",
        "FIRST_USE"
      ]
    },
    "passUseDays": {
      "description": "Expire new guest pass if not used within",
      "type": "integer"
    },
    "maxDevices": {
      "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
        }
      },
      "description": "max Devices"
    },
    "sessionDuration": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "requireLoginAgain": {
          "type": "boolean"
        },
        "sessionValue": {
          "type": "integer"
        },
        "sessionUnit": {
          "enum": [
            "MIN",
            "HOUR",
            "DAY",
            "WEEK"
          ]
        }
      },
      "description": "session duration"
    }
  },
  "required": [
    "wlan",
    "zone",
    "passValidFor",
    "maxDevices"
  ]
}
Response  201

Delete

DELETE/v5_1/identity/guestpass/{userId}

Use this API command to delete identity guest pass.

Response  204

Delete Multiple Identity Guest Passes

DELETE/v5_1/identity/guestpass

Use this API command to delete multiple identity guest passes.

Request
HideShow
Body
{
  "idList": [
    "b5f02dbf-c769-436d-ae2d-44a6af194b57",
    "839f87c6-d116-497e-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

DNS Server Management

Retrieve List - DNS server profile by query critaria

POST/v5_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.

Request
HideShow
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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for User Traffic profile"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the dns server service"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the dns server service"
          },
          "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/v5_1/profiles/dnsserver

Use this API command to delete a list of DNS server profile .

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Retrieve list

GET/v5_1/profiles/dnsserver

Use this API command to retrieve a list of DNS server profile.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for User Traffic profile"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the dns server service"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the dns server service"
          },
          "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/v5_1/profiles/dnsserver/{id}

Use this API command to retrieve DNS server profile.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the dns server service"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the dns server service"
    },
    "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/v5_1/profiles/dnsserver

Use this API command to create DNS server profile.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the dns server service"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the dns server service"
    },
    "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"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/profiles/dnsserver/{id}

Use this API command to modify the basic information of DNS server profile.

Request
HideShow
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
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the dns server service"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the dns server service"
  },
  "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"
  }
}
Response  204

Delete

DELETE/v5_1/profiles/dnsserver/{id}

Use this API command to delete DNS server profile.

Response  204

Clone

POST/v5_1/profiles/dnsserver/clone/{id}

Use this API command to clone an DNS server profile.

Request
HideShow
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"
    }
  }
}
Response  200
HideShow
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"
    }
  }
}

Identity Subscription Package

Retrieve subscription package list

GET/v5_1/identity/packages

Use this API command to retrieve a list of subscription package.

Response  200
HideShow
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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for subscription package"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "the identifier of the subscription package",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "name of the subscription package"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "description of the subscription package"
          },
          "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/v5_1/identity/packageList

Use this API command to retrieve a list of subscription package.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for subscription package"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "the identifier of the subscription package",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "name of the subscription package"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "description of the subscription package"
          },
          "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/v5_1/identity/packages/{id}

Use this API command to retrieve subscription package.

Response  200
HideShow
Body
{
  "name": "subscription-package-name",
  "description": "description",
  "expirationInterval": "DAY",
  "expirationValue": 3
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "name"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "description of the subscription package"
    },
    "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/v5_1/identity/packages

Use this API command to create subscription package.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "name of subscription package"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "description of the subscription package"
    },
    "expirationInterval": {
      "description": "Expiration interval",
      "enum": [
        "HOUR",
        "DAY",
        "WEEK",
        "MONTH",
        "YEAR",
        "NEVER"
      ]
    },
    "expirationValue": {
      "description": "Expiration value",
      "type": "integer"
    }
  },
  "required": [
    "name",
    "expirationInterval",
    "expirationValue"
  ]
}
Response  201
HideShow
Body
{
  "id": "e5db11b3-71ff-4234-80d0-c7562e9868af"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the create object",
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/identity/packages/{id}

Use this API command to modify the basic information of subscription package.

Request
HideShow
Body
{
  "name": "subscription-package-name",
  "description": "description",
  "expirationInterval": "DAY",
  "expirationValue": 3
}
Schema
{
  "id": {
    "description": "ID",
    "type": "string"
  },
  "domainId": {
    "description": "Domain Id",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "name of subscription package"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "description of the subscription package"
  },
  "expirationInterval": {
    "description": "Expiration interval",
    "enum": [
      "HOUR",
      "DAY",
      "WEEK",
      "MONTH",
      "YEAR",
      "NEVER"
    ]
  },
  "expirationValue": {
    "description": "Expiration value",
    "type": "integer"
  }
}
Response  204

Delete

DELETE/v5_1/identity/packages/{id}

Use this API command to delete subscription package.

Response  204

Delete

DELETE/v5_1/identity/packages

Use this API command to delete multiple subscription packages.

Request
HideShow
Body
{
  "idList": [
    "b5f02dbf-c769-436d-ae2d-44a6af194b57",
    "839f87c6-d116-497e-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Test AAA Server

Test AAA

POST/v5_1/system/aaa/test

Use this API command to test AAA server.

Request
HideShow
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": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "AAA server id or name"
    },
    "userName": {
      "description": "User name",
      "type": "string"
    },
    "password": {
      "description": "Password",
      "type": "string"
    },
    "authProtocol": {
      "description": "Authentication protocol",
      "enum": [
        "PAP",
        "CHAP"
      ],
      "default": "PAP"
    }
  },
  "required": [
    "aaaServer",
    "userName",
    "password"
  ]
}
Response  200
HideShow
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"
    }
  }
}

Dynamic PSK

Retrieve DPSK info By Zone

GET/v5_1/rkszones/{zoneId}/dpsk

Use this API command to retrieve DPSK info of a zone.

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

Use this API command to retrieve DPSK info of a WLAN.

Response  200
HideShow
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/v5_1/rkszones/{zoneId}/wlans/{id}/dpsk/{dpskId}

Use this API command to retrieve DPSK info.

Response  200
HideShow
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/v5_1/rkszones/{zoneId}/wlans/{id}/dpsk/upload

Use this API command to upload DPSK file of a WLAN (CSV file is only accepted).

Request
HideShow
Body
The DPSK file
Response  201

Batch Generate DPSKs

POST/v5_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.

Request
HideShow
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"
        }
    }
}
Response  201
HideShow
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/v5_1/rkszones/{zoneId}/deleteExpiredDpsk

Use this API command to retrieve interval of delete expired DPSK of a zone.

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

Use this API command to modify interval of delete expired DPSK of a zone.

Request
HideShow
Body
{
  "deleteExpiredDpsk": "AfterOneDay"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "deleteExpiredDpsk": {
      "description": "Delete expired DPSK interval of the Zone.",
      "enum": [
        "Never",
        "AfterOneDay",
        "AfterSixMonths"
      ]
    }
  }
}
Response  204

Delete DPSK

POST/v5_1/rkszones/{zoneId}/wlans/{id}/dpsk

Use this API command to delete DPSKs of a WLAN.

Request
HideShow
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"
      }
    }
  }
}
Response  200
HideShow
Body
{
  "resultCount": 2
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "resultCount": {
      "type": "integer"
    }
  }
}

Update DPSK info By Id

PATCH/v5_1/rkszones/{zoneId}/wlans/{id}/dpsk/{dpskId}

Use this API command to update DPSK info.

Request
HideShow
Body
{
  "userName": "updateUserName01"
}
Schema
{
  "userName": {
    "description": "User Name of DPSK",
    "type": "string"
  }
}
Response  204

Retrieve DPSK Enabled WLAN info By Zone.

GET/v5_1/rkszones/{zoneId}/dpskEnabledWlans

Use this API command to retrieve DPSK enabled WLAN info of a zone.

Response  200
HideShow
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"
          }
        }
      }
    }
  }
}

Download DPSK CSV sample

GET/v5_1/rkszones/downloadDpskCsvSample

Use this API command to download DPSK CSV sample.

URI Parameters
HideShow
type
string (optional) 

DPSK CSV sample type. Valid value is PHASE1 or PHASE2. Default: PHASE2.

Response  200

SNMP Agent

Retrieve SNMP Agent

GET/v5_1/system/snmpAgent

Retrieve SNMP Agent setting.

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

Modify syslog server setting.

Request
HideShow
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"
  ]
}
Response  204

Bridge

Retrieve List

GET/v5_1/profiles/bridge

Use this API command to retrieve a list of Bridge profile.

Response  200
HideShow
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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for profile"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the profile"
          }
        }
      }
    },
    "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/v5_1/profiles/bridge/{id}

Use this API command to retrieve Bridge profile by ID.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of Bridge profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the Bridge profile"
    },
    "dhcpRelay": {
      "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": {
          "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"
            }
          },
          "description": "DHCP Option 82"
        }
      },
      "description": "DHCP Relay"
    },
    "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/v5_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.

Request
HideShow
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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of Bridge profile"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the Bridge profile"
          },
          "dhcpRelay": {
            "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": {
                "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"
                  }
                },
                "description": "DHCP Option 82"
              }
            },
            "description": "DHCP Relay"
          },
          "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"
            }
          }
        }
      }
    }
  }
}

DiffServ

Retrieve list

GET/v5_1/rkszones/{zoneId}/diffserv

Use this API command to retrieve a list of DiffServ profile.

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

Use this API command to retrieve DiffServ profile.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the diffserv"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the diffserv"
    },
    "uplinkDiffServ": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "uplinkEnable": {
          "description": "Uplink enable",
          "type": "boolean"
        },
        "uplink": {
          "description": "Uplink",
          "type": "string"
        }
      },
      "description": "Tunnel DiffServ - Set Uplink Diffserv"
    },
    "downlinkDiffServ": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "downlinkEnable": {
          "description": "Downlink enable",
          "type": "boolean"
        },
        "downlink": {
          "description": "Downlink",
          "type": "string"
        }
      },
      "description": "Tunnel DiffServ - Set Downlink Diffserv"
    },
    "preservedList": {
      "type": "array",
      "description": "Preserved list",
      "items": {
        "type": "string"
      }
    }
  }
}

Create

POST/v5_1/rkszones/{zoneId}/diffserv

Use this API command to create DiffServ profile.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the diffserv"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the diffserv"
    },
    "uplinkDiffServ": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "uplinkEnable": {
          "description": "Uplink enable",
          "type": "boolean"
        },
        "uplink": {
          "description": "Uplink",
          "type": "string"
        }
      },
      "description": "Tunnel DiffServ - Set Uplink Diffserv"
    },
    "downlinkDiffServ": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "downlinkEnable": {
          "description": "Downlink enable",
          "type": "boolean"
        },
        "downlink": {
          "description": "Downlink",
          "type": "string"
        }
      },
      "description": "Tunnel DiffServ - Set Downlink Diffserv"
    },
    "preservedList": {
      "type": "array",
      "description": "Preserved list",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "0a6987e0-cedd-11e4-8148-f0def13d5845"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the create object",
      "type": "string"
    }
  }
}

Modify Basic

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

Use this API command to modify the basic information of DiffServ profile.

Request
HideShow
Body
{
  "name": "DiffServ name",
  "description": "DiffServ description"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the diffserv"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the diffserv"
  }
}
Response  204

Modify Preserved List

PATCH/v5_1/rkszones/{zoneId}/diffserv/{id}/preservedList

Use this API command to modify preserved list.

Request
HideShow
Body
[
  "20",
  "21",
  "22",
  "23",
  "24",
  "26"
]
Schema
{
  "type": "array",
  "description": "Preserved list",
  "items": {
    "type": "string"
  }
}
Response  204

Delete

DELETE/v5_1/rkszones/{zoneId}/diffserv/{id}

Use this API command to delete DiffServ profile.

Response  204

IndoorMap

Create IndoorMap

POST/v5_1/maps

Use this API command to create indoorMap.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "name"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "description"
    },
    "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": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "a": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "x": {
              "description": "x",
              "type": "number"
            },
            "y": {
              "description": "y",
              "type": "number"
            }
          },
          "description": "point a"
        },
        "b": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "x": {
              "description": "x",
              "type": "number"
            },
            "y": {
              "description": "y",
              "type": "number"
            }
          },
          "description": "point b"
        },
        "distance": {
          "description": "distance",
          "type": "number"
        },
        "unit": {
          "description": "unit",
          "enum": [
            "MM",
            "CM",
            "M",
            "Foot",
            "Yard"
          ]
        }
      },
      "description": "scale"
    },
    "apGroupId": {
      "description": "apGroupId",
      "type": "string"
    }
  },
  "required": [
    "name",
    "description",
    "groupType"
  ]
}
Response  201
HideShow
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/v5_1/maps/{indoorMapId}

Use this API command to delete indoor map.

Response  204
HideShow
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/v5_1/maps/{indoorMapId}

Use this API command to get indoor maps.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "name"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "description"
    },
    "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": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "a": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "x": {
              "description": "x",
              "type": "number"
            },
            "y": {
              "description": "y",
              "type": "number"
            }
          },
          "description": "point a"
        },
        "b": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "x": {
              "description": "x",
              "type": "number"
            },
            "y": {
              "description": "y",
              "type": "number"
            }
          },
          "description": "point b"
        },
        "distance": {
          "description": "distance",
          "type": "number"
        },
        "unit": {
          "description": "unit",
          "enum": [
            "MM",
            "CM",
            "M",
            "Foot",
            "Yard"
          ]
        }
      },
      "description": "scale"
    },
    "apGroupId": {
      "description": "apGroupId",
      "type": "string"
    }
  },
  "required": [
    "name",
    "description",
    "groupType"
  ]
}

Update indoor map

PATCH/v5_1/maps/{indoorMapId}

Use this API command to update specific indoor map.

Request
HideShow
Body
{
  "zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
  "name": "MapName",
  "description": "Description",
  "groupType": "ZONE",
  "address": "Location",
  "latitude": "25.07858",
  "longitude": "121.57141",
  "orientation": "HORIZONTAL",
  "imageData": "The base64 encoded data of image",
  "imageFileName": "map.jpg",
  "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c"
}
Schema
{
  "id": {
    "description": "id",
    "type": "string"
  },
  "zoneId": {
    "description": "zoneId",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "name"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "description"
  },
  "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"
  },
  "apGroupId": {
    "description": "apGroupId",
    "type": "string"
  }
}
Response  204
HideShow
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/v5_1/maps/{indoorMapId}/scale

Use this API command to update the scale of specific indoor map.

Request
HideShow
Body
{
  "a": {
    "x": 252.6392059326172,
    "y": 187.01136779785156
  },
  "b": {
    "x": 360.63922119140625,
    "y": 184.01136779785156
  },
  "distance": 3,
  "unit": "M"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "a": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "x": {
          "description": "x",
          "type": "number"
        },
        "y": {
          "description": "y",
          "type": "number"
        }
      },
      "description": "point a"
    },
    "b": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "x": {
          "description": "x",
          "type": "number"
        },
        "y": {
          "description": "y",
          "type": "number"
        }
      },
      "description": "point b"
    },
    "distance": {
      "description": "distance",
      "type": "number"
    },
    "unit": {
      "description": "unit",
      "enum": [
        "MM",
        "CM",
        "M",
        "Foot",
        "Yard"
      ]
    }
  },
  "description": "scale"
}
Response  204

Get indoor map list

GET/v5_1/maps

Use this API command to get indoor map list.

URI Parameters
HideShow
groupId
string (required) 
groupType
string (required) 
Response  200
HideShow
Body
{
  "totalCount": 3,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "key": "93b59041-1e97-4048-be43-4909553c78b6",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "DemoMap",
      "description": "",
      "imageData": "The base64 encoded data of image",
      "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",
      "imageData": "The base64 encoded data of image",
      "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": "",
      "imageData": "The base64 encoded data of image",
      "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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for indoor map"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "id",
            "type": "string"
          },
          "zoneId": {
            "description": "zoneId",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "name"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "description"
          },
          "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": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "a": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "x": {
                    "description": "x",
                    "type": "number"
                  },
                  "y": {
                    "description": "y",
                    "type": "number"
                  }
                },
                "description": "point a"
              },
              "b": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "x": {
                    "description": "x",
                    "type": "number"
                  },
                  "y": {
                    "description": "y",
                    "type": "number"
                  }
                },
                "description": "point b"
              },
              "distance": {
                "description": "distance",
                "type": "number"
              },
              "unit": {
                "description": "unit",
                "enum": [
                  "MM",
                  "CM",
                  "M",
                  "Foot",
                  "Yard"
                ]
              }
            },
            "description": "scale"
          },
          "apGroupId": {
            "description": "apGroupId",
            "type": "string"
          }
        },
        "required": [
          "name",
          "description",
          "groupType"
        ]
      }
    }
  }
}

Put Aps in indoor map

PUT/v5_1/maps/{indoorMapId}/aps

Use this API command to put Aps in indoor map.

Request
HideShow
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": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "x": {
            "description": "x",
            "type": "number"
          },
          "y": {
            "description": "y",
            "type": "number"
          }
        },
        "description": "location of this AP"
      }
    }
  }
}
Response  204
HideShow
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/v5_1/maps/query

Use this API command to query indoorMap. Please click the link for the usage of Query Cirteria.

Response  200
HideShow
Body
{
  "totalCount": 3,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "key": "93b59041-1e97-4048-be43-4909553c78b6",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "DemoMap",
      "description": "",
      "imageData": "The base64 encoded data of image",
      "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",
      "imageData": "The base64 encoded data of image",
      "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": "",
      "imageData": "The base64 encoded data of image",
      "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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for indoor map"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "id",
            "type": "string"
          },
          "zoneId": {
            "description": "zoneId",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "name"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "description"
          },
          "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": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "a": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "x": {
                    "description": "x",
                    "type": "number"
                  },
                  "y": {
                    "description": "y",
                    "type": "number"
                  }
                },
                "description": "point a"
              },
              "b": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "x": {
                    "description": "x",
                    "type": "number"
                  },
                  "y": {
                    "description": "y",
                    "type": "number"
                  }
                },
                "description": "point b"
              },
              "distance": {
                "description": "distance",
                "type": "number"
              },
              "unit": {
                "description": "unit",
                "enum": [
                  "MM",
                  "CM",
                  "M",
                  "Foot",
                  "Yard"
                ]
              }
            },
            "description": "scale"
          },
          "apGroupId": {
            "description": "apGroupId",
            "type": "string"
          }
        },
        "required": [
          "name",
          "description",
          "groupType"
        ]
      }
    }
  }
}

DHCP

Create DHCP Pool

POST/v5_1/rkszones/{zoneId}/dhcpSite/dhcpProfile

Use this API command to create DHCP Pool.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the DHCP Profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the DHCP Profile"
    },
    "vlanId": {
      "description": "VLAN ID of the DHCP Profile",
      "type": "integer",
      "minimum": 2,
      "maximum": 4094
    },
    "subnetNetworkIp": {
      "type": "string",
      "description": "Subnet Network IP of the DHCP Profile"
    },
    "subnetMask": {
      "type": "string",
      "description": "Subnet Mask of the DHCP Profile"
    },
    "poolStartIp": {
      "type": "string",
      "description": "Pool Starting IP of the DHCP Profile"
    },
    "poolEndIp": {
      "type": "string",
      "description": "Pool Ending IP of the DHCP Profile"
    },
    "primaryDnsIp": {
      "type": "string",
      "description": "Primany DNS IP of the DHCP Profile"
    },
    "secondaryDnsIp": {
      "type": "string",
      "description": "Secondary DNS IP of the DHCP Profile"
    },
    "leaseTimeHours": {
      "description": "Lease time in hours of the DHCP Profile",
      "type": "integer",
      "minimum": 0,
      "maximum": 24
    },
    "leaseTimeMinutes": {
      "description": "Lease time in minutes of the DHCP Profile",
      "type": "integer",
      "minimum": 0,
      "maximum": 59
    }
  },
  "required": [
    "name",
    "vlanId",
    "subnetNetworkIp",
    "subnetMask",
    "poolStartIp",
    "poolEndIp",
    "leaseTimeHours",
    "leaseTimeMinutes"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Get DHCP Pool by Pool's ID

GET/v5_1/rkszones/{zoneId}/dhcpSite/dhcpProfile/{id}

Use this API command to get DHCP Pool by pool’s ID.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the DHCP Profile"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the DHCP Profile"
    },
    "vlanId": {
      "description": "VLAN ID of the DHCP Profile",
      "type": "integer",
      "minimum": 2,
      "maximum": 4094
    },
    "subnetNetworkIp": {
      "type": "string",
      "description": "Subnet Network IP of the DHCP Profile"
    },
    "subnetMask": {
      "type": "string",
      "description": "Subnet Mask of the DHCP Profile"
    },
    "poolStartIp": {
      "type": "string",
      "description": "Pool Starting IP of the DHCP Profile"
    },
    "poolEndIp": {
      "type": "string",
      "description": "Pool Ending IP of the DHCP Profile"
    },
    "primaryDnsIp": {
      "type": "string",
      "description": "Primany DNS IP of the DHCP Profile"
    },
    "secondaryDnsIp": {
      "type": "string",
      "description": "Secondary DNS IP of the DHCP Profile"
    },
    "leaseTimeHours": {
      "description": "Lease time in hours of the DHCP Profile",
      "type": "integer",
      "minimum": 0,
      "maximum": 24
    },
    "leaseTimeMinutes": {
      "description": "Lease time in minutes of the DHCP Profile",
      "type": "integer",
      "minimum": 0,
      "maximum": 59
    }
  }
}

Get DHCP Pool list

GET/v5_1/rkszones/{zoneId}/dhcpSite/dhcpProfile

Use this API command to get DHCP Pool list.

Response  200
HideShow
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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the DHCP Profile"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the DHCP Profile"
          },
          "vlanId": {
            "description": "VLAN ID of the DHCP Profile",
            "type": "integer",
            "minimum": 2,
            "maximum": 4094
          },
          "subnetNetworkIp": {
            "type": "string",
            "description": "Subnet Network IP of the DHCP Profile"
          },
          "subnetMask": {
            "type": "string",
            "description": "Subnet Mask of the DHCP Profile"
          },
          "poolStartIp": {
            "type": "string",
            "description": "Pool Starting IP of the DHCP Profile"
          },
          "poolEndIp": {
            "type": "string",
            "description": "Pool Ending IP of the DHCP Profile"
          },
          "primaryDnsIp": {
            "type": "string",
            "description": "Primany DNS IP of the DHCP Profile"
          },
          "secondaryDnsIp": {
            "type": "string",
            "description": "Secondary DNS IP of the DHCP Profile"
          },
          "leaseTimeHours": {
            "description": "Lease time in hours of the DHCP Profile",
            "type": "integer",
            "minimum": 0,
            "maximum": 24
          },
          "leaseTimeMinutes": {
            "description": "Lease time in minutes of the DHCP Profile",
            "type": "integer",
            "minimum": 0,
            "maximum": 59
          }
        }
      }
    },
    "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/v5_1/rkszones/{zoneId}/dhcpSite/dhcpSiteConfig

Use this API command to get DHCP Configuration.

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

Get AP DHCP Pools Usage.

GET/v5_1/dhcpData/dhcpPools/{apMac}

Use this API command to get AP DHCP Pools Usage.

Response  200
HideShow
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/v5_1/dhcpData/dhcpPools/{apMac}/{poolIndex}

Use this API command to get AP DHCP Pool Usage by pool’s index.

Response  200
HideShow
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/v5_1/dhcpData/dhcpMsgStats/{apMac}

Use this API command to get AP DHCP Message Statistic.

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

Use this API command to modify DHCP Pool by pool’s ID.

Request
HideShow
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
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the DHCP Profile"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the DHCP Profile"
  },
  "vlanId": {
    "description": "VLAN ID of the DHCP Profile",
    "type": "integer",
    "minimum": 2,
    "maximum": 4094
  },
  "subnetNetworkIp": {
    "type": "string",
    "description": "Subnet Network IP of the DHCP Profile"
  },
  "subnetMask": {
    "type": "string",
    "description": "Subnet Mask of the DHCP Profile"
  },
  "poolStartIp": {
    "type": "string",
    "description": "Pool Starting IP of the DHCP Profile"
  },
  "poolEndIp": {
    "type": "string",
    "description": "Pool Ending IP of the DHCP Profile"
  },
  "primaryDnsIp": {
    "type": "string",
    "description": "Primany DNS IP of the DHCP Profile"
  },
  "secondaryDnsIp": {
    "type": "string",
    "description": "Secondary DNS IP of the DHCP Profile"
  },
  "leaseTimeHours": {
    "description": "Lease time in hours of the DHCP Profile",
    "type": "integer",
    "minimum": 0,
    "maximum": 24
  },
  "leaseTimeMinutes": {
    "description": "Lease time in minutes of the DHCP Profile",
    "type": "integer",
    "minimum": 0,
    "maximum": 59
  }
}
Response  204

Delete DHCP Pool by pool's ID

DELETE/v5_1/rkszones/{zoneId}/dhcpSite/dhcpProfile/{id}

Use this API command to delete DHCP Pool by pool’s ID.

Response  204

Delete multiple DHCP Pools

DELETE/v5_1/rkszones/{zoneId}/dhcpSite/dhcpProfile

Use this API command to delete multiple DHCP Pools.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

SCG User

Add SCG user

POST/v5_1/users

Add SCG user.

Request
HideShow
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
      ]
    },
    "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"
    }
  }
}
Response  200
HideShow
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/v5_1/users/{userId}

Get SCG user.

Response  200
HideShow
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
      ]
    },
    "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/v5_1/users/query

Query SCG users. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "userName": "user1",
      "passphrase": null,
      "realName": "john",
      "title": "CEO",
      "phone": "123456",
      "email": "[email protected]",
      "enabled": 1,
      "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
            ]
          },
          "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/v5_1/users/{userId}

Update SCG user.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "userName": "user1",
  "passphrase": "admin!234",
  "realName": "John",
  "title": "CEO",
  "phone": "123456",
  "email": "[email protected]"
}
Schema
{
  "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
    ]
  },
  "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"
  }
}
Response  200
HideShow
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/v5_1/users/{userId}

Delete SCG user.

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

Delete multiple SCG user.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

SCG User Group

Add SCG user group

POST/v5_1/userGroups

Add SCG user group.

Request
HideShow
Body
{
  "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,
      "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"
      ]
    },
    "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
            ]
          },
          "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"
    }
  }
}
Response  201
HideShow
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/v5_1/userGroups/{userGroupId}

Delete SCG user group.

Response  204
HideShow
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/v5_1/userGroups

Delete multiple SCG user group.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

Get SCG user group

GET/v5_1/userGroups/{userGroupId}

Get SCG user group.

URI Parameters
HideShow
includeUsers
boolean (optional) 
Response  200
HideShow
Body
{
  "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,
      "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"
      ]
    },
    "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
            ]
          },
          "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"
    }
  }
}

Get permitted categories of current user

GET/v5_1/userGroups/currentUser/permissionCategories

Get permitted categories of current user.

Response  200
HideShow
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": 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": {
          "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"
        }
      }
    }
  }
}

Get pre-defined roles

GET/v5_1/userGroups/roles

Get pre-defined roles.

Response  200
HideShow
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/v5_1/userGroups/roles/{role}/permissions

Get permission items of role.

Response  200
HideShow
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": 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": {
          "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"
        }
      }
    }
  }
}

Query user groups

POST/v5_1/userGroups/query

Query user groups. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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,
          "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"
            ]
          },
          "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
                  ]
                },
                "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"
          }
        }
      }
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Update user groups

PATCH/v5_1/userGroups/{userGroupId}

Update user groups.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "group1",
  "description": "",
  "role": "AP_ADMIN"
}
Schema
{
  "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"
    ]
  },
  "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"
  }
}
Response  204
HideShow
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/v5_1/userGroups/{userGroupId}/permissions

Update permissions of user groups.

Request
HideShow
Body
[
  {
    "resource": "AP_CATEGORY",
    "access": "MODIFY"
  },
  {
    "resource": "WLAN_CATEGORY",
    "access": "MODIFY"
  },
  {
    "resource": "DEVICE_CATEGORY",
    "access": "READ"
  }
]
Schema
{
  "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"
        }
      }
    }
  }
}
Response  204

Update permission scope of user groups

PATCH/v5_1/userGroups/{userGroupId}/resourceGroups

Update permission scope of user groups.

Request
HideShow
Body
[
  {
    "type": "DOMAIN",
    "id": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
  }
]
Schema
{
  "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"
      }
    }
  }
}
Response  204

Update user list of user groups

PATCH/v5_1/userGroups/{userGroupId}/users

Update user list of user groups.

Request
HideShow
Body
[
  {
    "userName": "user1",
    "realName": "john",
    "title": "CEO",
    "phone": "123456",
    "email": "[email protected]",
    "enabled": 1,
    "tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
    "companyName": "ruckus",
    "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
    "id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
  }
]
Schema
{
  "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
        ]
      },
      "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"
      }
    }
  }
}
Response  204

Query With Filter

Query WLANs

POST/v5_1/query/wlan

Query WLANs with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for wlan list"
    },
    "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/v5_1/query/services/aaaServer

Query AAAServers with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for AAA server list"
    },
    "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/v5_1/query/services/aaaServer/auth

Query Authentication AAAServers with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for AAA server list"
    },
    "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/v5_1/query/services/aaaServer/acct

Query Accounting AAAServers with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for AAA server list"
    },
    "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/v5_1/query/client

Query clients with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for client list"
    },
    "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/v5_1/query/dpsk

Query DPSKs with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for DPSK list"
    },
    "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/v5_1/query/user

Query users with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Retrieve Wlan Scheduler List

POST/v5_1/query/services/wlanScheduler

Query Wlan Schedulers with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Retrieve wechat portal List

POST/v5_1/query/services/wechatProfile

Query Wechat Portals with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Retrieve Web Authentication profile List

POST/v5_1/query/services/webAuthentication

Query Web Authentications with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Retrieve Vlan Pooling Profile List

POST/v5_1/query/services/vlanPooling

Query Vlan Pooling Profiles with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Retrieve Venue Profile List

POST/v5_1/query/services/venueProfile

Query Venue Profiles with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Retrieve L2 AccessControl Profile List

POST/v5_1/query/services/l2AccessControl

Query L2 AccessControl Profiles with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Retrieve Hotspot20 Profile List

POST/v5_1/query/services/hotspot20Profile

Query Hotspot20 Profiles with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Retrieve Hotspot Profile List

POST/v5_1/query/services/hotspot

Query Hotspot Profiles with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Retrieve Guess Access Profile List

POST/v5_1/query/services/guessAccess

Query Guess Access Profiles with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Retrieve Ethernet Port Profile List

POST/v5_1/query/services/ethernetPortProfile

Query Ethernet Port Profiles with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Retrieve DSCP Profile List

POST/v5_1/query/services/dscpProfile

Query DSCP Profiles with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Retrieve DHCP Profile List

POST/v5_1/query/services/dhcpProfile

Query DHCP Profiles with specified filters. Please click the link for the usage of Query Cirteria.

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

Query Device Policy Profiles with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Query Rogue AP List

POST/v5_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.

Request
HideShow
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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "rawDataTotalCount": 100,
  "totalCount": 10,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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"
    },
    {
      "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" : {
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                                    "description" : "AP MAC of the rogue AP"
                                },
                                "apName" : {
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 64,
                                    "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
                                    "description" : "Name of the rogue AP"
                                },
                                "rssi" : {
                                    "description" : "RSSI of the rogue AP",
                                    "type" : "string"
                                },
                                "lastDetected" : {
                                    "description" : "Timestamp of the AP",
                                    "type" : "integer"
                                },
                                "zoneName" : {
                                    "description" : "Zone name",
                                    "type" : "string"
                                }
                            }
                        }
                    },
                    "channel" : {
                        "description" : "Channel of the rogue AP",
                        "type" : "integer"
                    },
                    "rogueMac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "Rogue MAC of the rogue AP"
                    },
                    "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" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "Rogue AP MAC of the rogue AP"
                    }
                }
            }
        }
    }
}

Query Mesh Neighbor AP List

POST/v5_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.

Request
HideShow
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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "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/v5_1/query/services/bonjourPolicy

Query bonjourPolicy Profiles with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Retrieve indoorMap List

POST/v5_1/query/indoorMap

Query indoorMap with specified filters. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 3,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "testMap",
      "description": "",
      "imageData": "data:image/png;base64,***",
      "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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for indoor map"
    },
    "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "name"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "description"
          },
          "address": {
            "description": "address",
            "type": "string"
          },
          "imageData": {
            "description": "The base64 encoded data of image",
            "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": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "a": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "x": {
                    "description": "x",
                    "type": "number"
                  },
                  "y": {
                    "description": "y",
                    "type": "number"
                  }
                },
                "description": "point a"
              },
              "b": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "x": {
                    "description": "x",
                    "type": "number"
                  },
                  "y": {
                    "description": "y",
                    "type": "number"
                  }
                },
                "description": "point b"
              },
              "distance": {
                "description": "distance",
                "type": "number"
              },
              "unit": {
                "description": "unit",
                "enum": [
                  "MM",
                  "CM",
                  "M",
                  "Foot",
                  "Yard"
                ]
              }
            },
            "description": "scale"
          },
          "apGroupId": {
            "description": "apGroupId",
            "type": "string"
          }
        },
        "required": [
          "name",
          "description",
          "groupType"
        ]
      }
    }
  }
}

Event and Alarm

Retrieve Event List

POST/v5_1/alert/event/list

Query Events with specified filters.

Request
HideShow
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,
  "start": 70,
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "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/v5_1/alert/alarm/list

Query Alarms with specified filters.

Request
HideShow
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": 0,
  "start": 0,
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "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

PUT/v5_1/alert/alarm/{alarmID}/ack

Acknowledge a single Alarm with provided alarmID.

Response  200

Clear Alarm

PUT/v5_1/alert/alarm/{alarmID}/clear

Clear a single Alarm with provided alarmID.

Response  200

Acknowledge Alarms

PUT/v5_1/alert/alarm/ack

Acknowledge multiple Alarms with provided alarmIDs.

Request
HideShow
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"
      }
    }
  }
}
Response  204

Clear Alarms

PUT/v5_1/alert/alarm/clear

Clear multiple Alarms with provided alarmIDs.

Request
HideShow
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": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Comment for clearing alarm"
    }
  }
}
Response  204

LBS profile

Create LBS profile

GET/v5_1/profiles/lbs/{id}

Retrieve LBS profile.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "LBS name"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "LBS description"
    },
    "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/v5_1/profiles/lbs

Create LBS profile.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "LBS name"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "LBS description"
    },
    "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"
    }
  }
}
Response  200
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Update LBS profile

PATCH/v5_1/profiles/lbs/{id}

Update LBS profile.

Request
HideShow
Body
{
  "url": "172.17.60.79",
  "port": "8883",
  "password": "pwd$321",
  "venue": "Venue name"
}
Schema
{
  "id": {
    "description": "Profile Id",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "LBS name"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "LBS description"
  },
  "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"
  }
}
Response  200

Delete LBS profile

DELETE/v5_1/profiles/lbs/{id}

Delete LBS profile.

Response  200

Delete multiple LBS profile

DELETE/v5_1/profiles/lbs

Delete multiple LBS profile.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

Query LBS profiles

POST/v5_1/profiles/lbs/query

Query LBS profiles. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "LBS name"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "LBS description"
          },
          "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"
            }
          }
        }
      }
    }
  }
}

Control Planes

Retrieve List

GET/v5_1/enterprise/controlPlanes

Use this API command to retrieve the list of control plane.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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
{
  "additionalProperties": false,
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "list": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "clusterNode": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Cluster node"
          },
          "clusterRole": {
            "description": "Cluster role",
            "type": "string"
          },
          "description": {
            "description": "Description",
            "type": "string"
          },
          "macAddress": {
            "description": "MAC Address",
            "type": "string"
          },
          "mntIp": {
            "description": "Management/AP Tunnel IP",
            "type": "string"
          },
          "model": {
            "description": "Model",
            "type": "string"
          },
          "numOfAps": {
            "description": "Total Connected APs",
            "type": "string"
          },
          "serialNumber": {
            "description": "Serial Number",
            "type": "string"
          },
          "upTime": {
            "description": "Uptime",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "totalCount": {
      "type": "integer"
    }
  },
  "type": "object"
}

Retrieve

GET/v5_1/enterprise/controlPlanes/{bladeUUID}

Use this API command to retrieve control plane.

Response  200
HideShow
Body
{
  "ipMode": "STATIC",
  "ipAddress": "10.2.3.96",
  "subnetMask": "255.255.0.0",
  "gateway": "10.2.0.1",
  "primaryDNSServer": "172.17.17.16"
}
Schema
{
  "additionalProperties": false,
  "properties": {
    "gateway": {
      "description": "Gateway",
      "type": "string"
    },
    "ipAddress": {
      "description": "IP address",
      "type": "string"
    },
    "ipMode": {
      "description": "IP mode",
      "enum": [
        "STATIC",
        "DHCP"
      ]
    },
    "natIp": {
      "description": "NAT IP",
      "type": "string"
    },
    "primaryDNSServer": {
      "description": "Primary DNS server",
      "type": "string"
    },
    "secondaryDNSServer": {
      "description": "Secondary DNS server",
      "type": "string"
    },
    "subnetMask": {
      "description": "Subnet mask",
      "type": "string"
    }
  },
  "type": "object"
}

Modify Basic

PATCH/v5_1/enterprise/controlPlanes/{bladeUUID}

Use this API command to modify the basic information of control plane.

Request
HideShow
Body
{
  "gateway": "10.2.0.1",
  "ipAddress": "10.2.3.96",
  "ipMode": "STATIC",
  "primaryDNSServer": "172.17.17.16",
  "subnetMask": "255.255.0.0"
}
Schema
{
  "gateway": {
    "description": "Gateway",
    "type": "string"
  },
  "ipAddress": {
    "description": "IP address",
    "type": "string"
  },
  "ipMode": {
    "description": "IP mode",
    "enum": [
      "STATIC",
      "DHCP"
    ]
  },
  "natIp": {
    "description": "NAT IP",
    "type": "string"
  },
  "primaryDNSServer": {
    "description": "Primary DNS server",
    "type": "string"
  },
  "secondaryDNSServer": {
    "description": "Secondary DNS server",
    "type": "string"
  },
  "subnetMask": {
    "description": "Subnet mask",
    "type": "string"
  }
}
Response  204

Retrieve static route

GET/v5_1/controlPlanes/{bladeUUID}/staticRoutes

Use this API command to retrieve static route of control plane.

Response  200
HideShow
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/v5_1/controlPlanes/{bladeUUID}/staticRoutes

Use this API command to modify the static route of control plane.

Request
HideShow
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
      }
    }
  }
}
Response  204

Delete Static Route

DELETE/v5_1/controlPlanes/{bladeUUID}/staticRoutes

Use this API command to delete the static route of control plane.

Response  204

Retrieve user defined interface

GET/v5_1/controlPlanes/{bladeUUID}/userDefinedInterface

Use this API command to retrieve user defined interface of control plane.

Response  200
HideShow
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/v5_1/controlPlanes/{bladeUUID}/userDefinedInterface

Use this API command to modify user defined interface of control plane.

Request
HideShow
Body
[
  {
    "name": "User Defined Interface name",
    "physicalInterface": "Control",
    "service": "NotSpecified",
    "ipAddress": "1.1.1.1",
    "subnetMask": "255.255.255.0",
    "vlan": "5"
  }
]
Schema
{
  "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"
      }
    }
  },
  "type": "array"
}
Response  204

Delete User Defined Interface

DELETE/v5_1/controlPlanes/{bladeUUID}/userDefinedInterface

Use this API command to delete the user defined interface of control plane.

Response  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, and no longer be supported.

Response  200
HideShow
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, and no longer be supported.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the Bonjour Gateway Policy"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the Bonjour Gateway Policy"
    },
    "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, and no longer be supported.

Request
HideShow
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" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the Bonjour Gateway Policy"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Bonjour Gateway Policy"
        },
        "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" ]
}
Response  201
HideShow
Body
{
  "id": "0a6987e0-cedd-11e4-8148-f0def13d5845"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the create object",
      "type": "string"
    }
  }
}

Modify Basic

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, and no longer be supported.

Request
HideShow
Body
{
  "name": "bonjour gateway policy name",
  "description": "bonjour gateway policy description"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the Bonjour Gateway Policy"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the Bonjour Gateway Policy"
  }
}
Response  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, and no longer be supported.

Request
HideShow
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" ]
    }
}
Response  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, and no longer be supported.

Request
HideShow
Body
{
  "enabledBonjourGateway": false
}
Schema
{
  "enabledBonjourGateway": {
    "description": "Enable Bonjour gateway on th AP",
    "type": "boolean"
  }
}
Response  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, and no longer be supported.

Response  204

Retrieve list

GET/v5_1/rkszones/{zoneId}/bonjourGateway/policies

Use this API command to retrieve a list of bonjour gateway policies.

Response  200
HideShow
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}/bonjourGateway/policies/{id}

Use this API command to retrieve bonjour gateway policy.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the Bonjour Gateway Policy"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "description": "Description of the Bonjour Gateway Policy"
    },
    "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}/bonjourGateway/policies

Use this API command to create bonjour gateway policy.

Request
HideShow
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" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the Bonjour Gateway Policy"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Bonjour Gateway Policy"
        },
        "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" ]
}
Response  201
HideShow
Body
{
  "id": "0a6987e0-cedd-11e4-8148-f0def13d5845"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the create object",
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/rkszones/{zoneId}/bonjourGateway/policies/{id}

Use this API command to modify the basic information of bonjour gateway policy.

Request
HideShow
Body
{
  "name": "bonjour gateway policy name",
  "description": "bonjour gateway policy description"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the Bonjour Gateway Policy"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the Bonjour Gateway Policy"
  }
}
Response  204

Modify bonjour gateway policy rule list

PATCH/v5_1/rkszones/{zoneId}/bonjourGateway/policies/{id}/bonjourPolicyRuleList

Use this API command to modify bonjour gateway policy rules.

Request
HideShow
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" ]
    }
}
Response  204

Modify Enable

PATCH/v5_1/rkszones/{zoneId}/bonjourGateway/enable

Use this API command to enable/disable bonjour gateway policy.

Request
HideShow
Body
{
  "enabledBonjourGateway": false
}
Schema
{
  "enabledBonjourGateway": {
    "description": "Enable Bonjour gateway on th AP",
    "type": "boolean"
  }
}
Response  204

Delete

DELETE/v5_1/rkszones/{zoneId}/bonjourGateway/policies/{id}

Use this API command to delete bonjour gateway policy.

Response  204

Bonjour Fencing Policy

Retrieve list

GET/v5_1/rkszones/{zoneId}/bonjourFencingPolicy

Use this API command to retrieve a list of Bonjour Fencing Policy.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "1c942d00-4f36-11e6-8512-0a0027000000",
      "name": "bonjourFencingPolicy",
      "description": "",
      "bonjourFencingRuleList": [
        {
          "deviceType": "Wired",
          "deviceMac": "00:22:33:66:44:55",
          "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" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Bonjour Fencing Policy id",
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                        "description" : "Name of the Bonjour Fencing Policy"
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the Bonjour Fencing Policy"
                    },
                    "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" ]
                                },
                                "deviceMac" : {
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                                    "description" : "Specify the device providing Bonjour Service"
                                },
                                "closestAp" : {
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                                    "description" : "Specify the closest AP while device connecting to AP wired"
                                },
                                "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" : {
                                    "type" : [ "string", "null" ],
                                    "maxLength" : 64,
                                    "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                                    "description" : "Description of the Bonjour Fencing Rule"
                                }
                            },
                            "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/v5_1/rkszones/{zoneId}/bonjourFencingPolicy/{id}

Use this API command to retrieve Bonjour Fencing Policy.

Response  200
HideShow
Body
{
  "id": "1c942d00-4f36-11e6-8512-0a0027000000",
  "name": "bonjourPolicy",
  "description": "",
  "bonjourFencingRuleList": [
    {
      "deviceType": "Wired",
      "deviceMac": "00:22:33:66:44:55",
      "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" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the Bonjour Fencing Policy"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Bonjour Fencing Policy"
        },
        "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" ]
                    },
                    "deviceMac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "Specify the device providing Bonjour Service"
                    },
                    "closestAp" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "Specify the closest AP while device connecting to AP wired"
                    },
                    "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" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the Bonjour Fencing Rule"
                    }
                },
                "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/v5_1/rkszones/{zoneId}/bonjourFencingPolicy

Use this API command to create Bonjour Fencing Policy.

Request
HideShow
Body
{
  "name": "bonjourPolicy",
  "description": "",
  "bonjourFencingRuleList": [
    {
      "deviceType": "Wired",
      "deviceMac": "00:22:33:66:44:55",
      "closestAp": "33:22:11:22:66:55",
      "description": "desc",
      "serviceType": "AIRPLAY",
      "fencingRange": "SameAp"
    }
  ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the Bonjour Fencing Policy"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Bonjour Fencing Policy"
        },
        "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" ]
                    },
                    "deviceMac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "Specify the device providing Bonjour Service"
                    },
                    "closestAp" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "Specify the closest AP while device connecting to AP wired"
                    },
                    "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" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the Bonjour Fencing Rule"
                    }
                },
                "required" : [ "deviceType", "serviceType", "fencingRange" ]
            }
        }
    },
    "required" : [ "name", "bonjourFencingRuleList" ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Basic

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

Use this API command to modify the basic information of Bonjour Fencing Policy.

Request
HideShow
Body
{
  "name": "bonjourPolicy123",
  "description": "this is desc"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the Bonjour Fencing Rule"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the Bonjour Fencing Rule"
  }
}
Response  204

Modify Bonjour Fencing Rule List

PATCH/v5_1/rkszones/{zoneId}/bonjourFencingPolicy/{id}/bonjourFencingRuleList

Use this API command to modify Bonjour Fencing Rule List.

Request
HideShow
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" ]
            },
            "deviceMac" : {
                "type" : "string",
                "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                "description" : "Specify the device providing Bonjour Service"
            },
            "closestAp" : {
                "type" : "string",
                "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                "description" : "Specify the closest AP while device connecting to AP wired"
            },
            "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" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Bonjour Fencing Rule"
            }
        },
        "required" : [ "deviceType", "serviceType", "fencingRange" ]
    }
}
Response  204

Delete

DELETE/v5_1/rkszones/bonjourFencingPolicy/{id}

Use this API command to delete Bonjour Fencing Policy.

Response  204

Delete

DELETE/v5_1/rkszones/bonjourFencingPolicy

Use this API command to delete Bulk Bonjour Fencing Policy.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Get Bonjour Fencing Statistic

GET/v5_1/aps/{apMac}/bonjourFencingStatistic

Use this API command to get Bonjour Fencing Statistic per AP.

Response  200
HideShow
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": {
        "type": "object",
        "additionalProperties": false,
        "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/v5_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.

Request
HideShow
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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "1c942d00-4f36-11e6-8512-0a0027000000",
      "name": "bonjourFencingPolicy",
      "description": "",
      "bonjourFencingRuleList": [
        {
          "deviceType": "Wired",
          "deviceMac": "00:22:33:66:44:55",
          "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" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Bonjour Fencing Policy id",
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                        "description" : "Name of the Bonjour Fencing Policy"
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the Bonjour Fencing Policy"
                    },
                    "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" ]
                                },
                                "deviceMac" : {
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                                    "description" : "Specify the device providing Bonjour Service"
                                },
                                "closestAp" : {
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                                    "description" : "Specify the closest AP while device connecting to AP wired"
                                },
                                "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" : {
                                    "type" : [ "string", "null" ],
                                    "maxLength" : 64,
                                    "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                                    "description" : "Description of the Bonjour Fencing Rule"
                                }
                            },
                            "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/v5_1/rkszones/{zoneId}/clientIsolationWhitelist

Create a new ClientIsolationWhitelist.

Request
HideShow
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" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Client Isolation Whitelist name"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Client Isolation Whitelist description"
        },
        "whitelist" : {
            "description" : "Client Isolation Whitelist array",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "mac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "Client Entry Mac"
                    },
                    "ip" : {
                        "description" : "Client Entry ip",
                        "type" : [ "string", "null" ]
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Client Entry description"
                    }
                },
                "required" : [ "mac" ]
            }
        },
        "clientIsolationAutoEnabled" : {
            "description" : "Client Isolation Auto Enable",
            "type" : "boolean"
        }
    },
    "required" : [ "name", "whitelist", "clientIsolationAutoEnabled" ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Retrieve List

GET/v5_1/rkszones/{zoneId}/clientIsolationWhitelist

Retrieve a list of Client Isolation Whitelist.

Response  200
HideShow
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" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Client Isolation Whitelist id",
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                        "description" : "Client Isolation Whitelist name"
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Client Isolation Whitelist description"
                    },
                    "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" : {
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                                    "description" : "Client Entry Mac"
                                },
                                "ip" : {
                                    "description" : "Client Entry ip",
                                    "type" : [ "string", "null" ]
                                },
                                "description" : {
                                    "type" : [ "string", "null" ],
                                    "maxLength" : 64,
                                    "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                                    "description" : "Client Entry description"
                                }
                            },
                            "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/v5_1/rkszones/{zoneId}/clientIsolationWhitelist/{id}

Retrieve an Client Isolation Whitelist.

Response  200
HideShow
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" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Client Isolation Whitelist name"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Client Isolation Whitelist description"
        },
        "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" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                        "description" : "Client Entry Mac"
                    },
                    "ip" : {
                        "description" : "Client Entry ip",
                        "type" : [ "string", "null" ]
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Client Entry description"
                    }
                },
                "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 Basic

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

Modify a specific Client Isolation Whitelist basic.

Request
HideShow
Body
{
  "name": "clientIsolationWhitelist_1",
  "description": "this is desc",
  "clientIsolationAutoEnabled": true
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Client Isolation Whitelist name"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Client Isolation Whitelist description"
  },
  "clientIsolationAutoEnabled": {
    "description": "Client Isolation Auto Enable",
    "type": "boolean"
  }
}
Response  204

Modify Client Isolation Whitelist entries configuration

PATCH/v5_1/rkszones/{zoneId}/clientIsolationWhitelist/{id}/whitelist

Modify Client Isolation Whitelist entries configuration.

Request
HideShow
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" : {
                "type" : "string",
                "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                "description" : "Client Entry Mac"
            },
            "ip" : {
                "description" : "Client Entry ip",
                "type" : [ "string", "null" ]
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Client Entry description"
            }
        },
        "required" : [ "mac" ]
    }
}
Response  204

Delete

DELETE/v5_1/rkszones/clientIsolationWhitelist/{id}

Delete a Client Isolation Whitelist.

Response  204

Delete

DELETE/v5_1/rkszones/clientIsolationWhitelist

Use this API command to delete Bulk Client Isolation Whitelist.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Retrieve List

POST/v5_1/query/services/clientIsolationWhitelist

Retrieve a list of Client Isolation Whitelist. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Client Isolation Whitelist id",
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                        "description" : "Client Isolation Whitelist name"
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Client Isolation Whitelist description"
                    },
                    "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" : {
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$",
                                    "description" : "Client Entry Mac"
                                },
                                "ip" : {
                                    "description" : "Client Entry ip",
                                    "type" : [ "string", "null" ]
                                },
                                "description" : {
                                    "type" : [ "string", "null" ],
                                    "maxLength" : 64,
                                    "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                                    "description" : "Client Entry description"
                                }
                            },
                            "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"
        }
    }
}

Precedence Profile

Create Precedence Profile

POST/v5_1/precedence

Use this API command to create Precedence Profile.

Request
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the precedence profile"
    },
    "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"
          }
        }
      }
    }
  }
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Get Precedence Profile by profile's ID

GET/v5_1/precedence/{id}

Use this API command to Get Precedence Profile by profile’s ID.

Response  200
HideShow
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": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
      "description": "Name of the precedence profile"
    },
    "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/v5_1/precedence

Use this API command to Get Precedence Profile list.

URI Parameters
HideShow
index
number (optional) 

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

listSize
number (optional) 

The maximum number of entries to be retrieved. Default: 100

Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for profile"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the profile"
          },
          "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/v5_1/precedence/{id}

Use this API command to Modify Precedence Profile by profile’s ID.

Request
HideShow
Body
{
  "name": "precedence-name02",
  "domainId": "0a782052-96d5-738b-afce-aa8157abd30c"
}
Schema
{
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the precedence profile"
  },
  "domainId": {
    "description": "Domain UUID",
    "type": "string"
  }
}
Response  200

Delete Precedence Profile by profile's ID

DELETE/v5_1/precedence/{id}

Use this API command to Delete Precedence Profile by profile’s ID.

Response  204

Bulk Delete Precedence Profile

DELETE/v5_1/precedence

Use this API command to Bulk Delete Precedence Profile.

Request
HideShow
Body
{
  "idList": [
    "d18e44e0-8af5-11e4-8155-000c299b4765",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Query Precedence Profile

POST/v5_1/precedence/query

Use this API command to query Precedence Profile. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "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",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for profile"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the profile"
          },
          "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"
                }
              }
            }
          }
        }
      }
    }
  }
}

Administration

Restart

POST/v5_1/restart

Use this API command to restart the controller.

Response  204

Shutdown

POST/v5_1/shutdown

Use this API command to shut down the controller.

Response  204

SCI

Create SCI Profile

POST/v5_1/sci/sciProfile

Use this API command to create sciProfile.

Request
HideShow
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"
  ]
}
Response  200
HideShow
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/v5_1/sci/sciProfile/{id}

Use this API command to retrieve sciProfile.

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

Use this API command to retrieve sciProfile list.

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

Use this API command to modify sciProfile.

Request
HideShow
Body
{
  "sciProfile": "SCI Profile 1",
  "sciSystemId": "SCI System ID 1",
  "sciServerHost": "172.17.33.36",
  "sciServerPort": "8883",
  "sciUser": "user",
  "sciPassword": "password"
}
Schema
{
  "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"
  }
}
Response  200

Modify SCI Priorities

POST/v5_1/sci/sciProfile/sciPriority

Use this API command to modify sciPriorities.

Request
HideShow
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"
        ]
      }
    }
  }
}
Response  200

Delete SCI Profile

DELETE/v5_1/sci/sciProfile/{id}

Use this API command to delete sciProfile.

Response  200

Delete SCI Profile list

DELETE/v5_1/sci/sciProfile

Use this API command to delete sciProfile list.

Request
HideShow
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"
        ]
      }
    }
  }
}
Response  200

Modify sciEnabled Setting

PATCH/v5_1/sci/sciEnabled

Use this API command to modify SCI settings is enabled or not.

Request
HideShow
Body
{
  "sciEnabled": true
}
Schema
{
  "sciEnabled": {
    "description": "Is SZ/SCI interface enabled or disabled",
    "type": "boolean"
  }
}
Response  200

Retrieve SCI Accepted Event Codes

GET/v5_1/sci/sciEventCode

Use this API command to retrieve SciAcceptedEventCodes.

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

Use this API command to modify SciAcceptedEventCodes.

Request
HideShow
Body
{
  "sciAcceptedEventCodes": [
    202,
    204
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "sciAcceptedEventCodes": {
      "type": "array",
      "items": {
        "description": "SCI accepted event code",
        "type": "integer"
      }
    }
  },
  "required": [
    "sciAcceptedEventCodes"
  ]
}
Response  200

Global reference

Get friendly name of usable language

GET/v5_1/globalSettings/friendlyNameLang

Use this API command to get friendly name of usable language for profile: Hotspot2.0 Identity Provider.

Response  200
HideShow
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/v5_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).

Response  200
HideShow
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"
          }
        }
      }
    }
  }
}

Wired Client

Query Wired Clients

POST/v5_1/query/wiredclient

Query wired clients with specified filters Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "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": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "description": "extra information for client list"
    },
    "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"
          }
        }
      }
    }
  }
}

Multicast Forwarding

{{ groupId :: multicastForwarding }}

Generated by aglio on 12 Jun 2017