Back to top

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}:7443/api/public", where {host} is the IP address of the management interface of the controller.

Common Request Header

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

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

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

HTTP Responses

Successful Requests

CodeResponseDescription
200OKThe request was completed successfully. Some API calls may return a 201 response instead.
201CreatedThe request was completed successfully and a resource was created.
204No ContentThe request was completed successfully, but there was no representation to return (that is, the response was empty).

Failed Requests

CodeResponseDescription
400Bad requestThe request could not be understood or was missing at least one required parameter.
401UnauthorizedAuthentication failed or you do not have the permission to perform the requested operation.
403ForbiddenAccess denied.
404Not foundThe resource could not be found.
405Method not allowedThe requested method is unsupported for the resource.
406Not acceptableThe controller is unable to send data in the format specified in the Accept header of the request.
422Unprocessable entityThe request was well-formed but it could not be completed because of semantic errors.

Errors

CodeResponseDescription
500Internal server errorThe request is valid, but the controller is unable to process the request.
503Service unavailableThe 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.

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

Logon Sessions 

The following API commands are used to acquire, retrieve, and release logon sessions.

Logon 

/v1_0/session

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

  • Request
  • Body
    {
        "username" : "admin",
        "password" : "admin!234",
        "apiVersions" : [ "1", "2" ],
        "timeZoneUtcOffset" : "+08:00"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "username" : {
                "description" : "Logon user name",
                "type" : "string"
            },
            "password" : {
                "description" : "Logon password",
                "type" : "string"
            },
            "domainName" : {
                "description" : "Logon domain name",
                "type" : "string"
            },
            "apiVersions" : {
                "description" : "API version supported by the client",
                "type" : "array",
                "items" : {
                    "type" : "string"
                },
                "minItems" : 1,
                "uniqueItems" : true
            },
            "timeZoneUtcOffset" : {
                "description" : "Local timezone of the client, offset to UTC",
                "enum" : [ "-12:00", "-11:00", "-10:00", "-09:30", "-09:00", "-08:00", "-07:00", "-06:00", "-05:00", "-04:30", "-04:00", "-03:30", "-03:00", "-02:00", "-01:00", "±00:00", "+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
  • Body
    {
        "controllerVersion" : "3.0.0.0.351"
    }
    
    
    Schema
    {
        "type" : "object",
        "properties" : {
            "controllerVersion" : {
                "type" : "string"
            }
        }
    }
    
    

Logoff 

/v1_0/session

Use this API command to log off of the controller.

  • Response  200

Retrieve 

/v1_0/session

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

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

Ruckus Wireless AP Zone 

Retrieve List 

/v1_0/rkszones

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

  • Parameters
  • index
    number (optional) 

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

    listSize
    number (optional) 

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

    domainId
    string (optional) 

    The domain ID. Default: current logon domain ID

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

Retrieve Mesh Configuration 

/v1_0/rkszones/{id}/mesh

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

  • Response  200
  • 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 

/v1_0/rkszones/{id}/mesh

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

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

Modify Basic 

/v1_0/rkszones/{id}

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

  • Request
  • Body
    {
        "domainId" : "domainUUIDToMove",
        "name" : "zoneModified",
        "description" : "description modified",
        "version" : "3.0.0.0.175",
        "countryCode" : "US"
    }
    
    
    Schema
    {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the zone"
        },
        "description" : {
            "type" : "string",
            "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"
        }
    }
    
    
  • Response  204

Modify Time Zone 

/v1_0/rkszones/{id}/timezone

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

  • Request
  • Body
    {
        "customizedTimezone" : {
            "abbreviation" : "ABC",
            "gmtOffset" : 4,
            "gmtOffsetMinute" : 10
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "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 in minutes",
                        "type" : "integer",
                        "minimum" : 0,
                        "maximum" : 59
                    },
                    "start" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "month" : {
                                "description" : "Month when daylight saving time begins",
                                "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                            },
                            "week" : {
                                "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                "enum" : [ 1, 2, 3, 4, 5 ]
                            },
                            "day" : {
                                "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                            },
                            "hour" : {
                                "description" : "Hour of the day",
                                "type" : "integer",
                                "minimum" : 0,
                                "maximum" : 23
                            }
                        },
                        "required" : [ "month", "week", "day", "hour" ],
                        "description" : "Daylight saving time start"
                    },
                    "end" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "month" : {
                                "description" : "Month when daylight saving time begins",
                                "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                            },
                            "week" : {
                                "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                "enum" : [ 1, 2, 3, 4, 5 ]
                            },
                            "day" : {
                                "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                            },
                            "hour" : {
                                "description" : "Hour of the day",
                                "type" : "integer",
                                "minimum" : 0,
                                "maximum" : 23
                            }
                        },
                        "required" : [ "month", "week", "day", "hour" ],
                        "description" : "Daylight saving time end"
                    }
                },
                "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ],
                "description" : "User-defined time zone"
            }
        },
        "description" : "Either systemTimezone or customizedTimezone must be specified"
    }
    
    
  • Response  204

Follow System Time Zone 

/v1_0/rkszones/{id}/timezone

Use this API command to reset the Time Zone with System Time Zone

  • Response  204

Modify AP Logon 

/v1_0/rkszones/{id}/login

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

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

AP Group 

Retrieve List 

/v1_0/rkszones/{zoneId}/apgroups

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

  • Parameters
  • index
    number (optional) 

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

    listSize
    number (optional) 

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

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

Retrieve 

/v1_0/rkszones/{zoneId}/apgroups/{id}

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

  • Response  200
  • Body
    {
        "id" : "apGroupUUID",
        "zoneId" : "zoneUUID",
        "name" : "apGroupName",
        "description" : "apGroupDescription",
        "members" : [ {
            "apMac" : "00:11:22:33:44:55"
        }, {
            "apMac" : "11:22:33:44:55:66"
        } ]
    }
    
    
    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"
            },
            "members" : {
                "description" : "Members of the AP group",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "apMac" : {
                            "type" : "string",
                            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
                            "description" : "MAC address of the member AP"
                        }
                    }
                }
            }
        },
        "required" : [ "name" ]
    }
    
    

Create 

/v1_0/rkszones/{zoneId}/apgroups

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

  • Request
  • 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",
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the AP group"
            }
        },
        "required" : [ "name" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "apGroupUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the AP group",
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v1_0/rkszones/{zoneId}/apgroups/{id}

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

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

Add Member 

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

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

  • Response  201

Remove Member 

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

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

  • Response  204

Delete 

/v1_0/rkszones/{zoneId}/apgroups/{id}

Use this API command to delete an AP group.

  • Response  204

Access Point Configuration 

Retrieve List 

/v1_0/aps

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

  • Parameters
  • index
    number (optional) 

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

    listSize
    number (optional) 

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

    zoneId
    string (optional) 

    filter AP list by zone

    domainId
    string (optional) 

    filter AP list by domain. Default: current logon domain

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

Retrieve 

/v1_0/aps/{apMac}

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

  • Response  200
  • Body
    {
        "zoneId" : "zoneUUID",
        "apGroupId" : "apGroupUUID",
        "serial" : "00000096",
        "model" : "ZF7343",
        "name" : "apName",
        "latitude" : 22.3,
        "longitude" : 114,
        "location" : "location",
        "description" : "apDescription",
        "administrativeState" : "Unlocked",
        "provisionChecklist" : "provisionChecklist",
        "login" : {
            "apLoginName" : "apLoginName",
            "apLoginPassword" : "apLoginPassword"
        },
        "wifi24" : {
            "txPower" : "txPower",
            "channelWidth" : 1,
            "channel" : 13
        },
        "wifi50" : {
            "txPower" : "txPower",
            "channelWidth" : 1,
            "indoorChannel" : 1,
            "outdoorChannel" : 2
        },
        "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"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "mac" : {
                "type" : "string",
                "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
                "description" : "MAC address of the AP"
            },
            "zoneId" : {
                "description" : "Identifier of the AP group to which the AP belongs",
                "type" : "string"
            },
            "apGroupId" : {
                "type" : "string"
            },
            "serial" : {
                "description" : "Serial number of the AP",
                "type" : "string"
            },
            "model" : {
                "description" : "Model name of the AP",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 64,
                "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
                "description" : "Name of the AP"
            },
            "description" : {
                "type" : "string",
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the AP"
            },
            "latitude" : {
                "type" : "number",
                "description" : "Latitude coordinate (in decimal format) of the AP"
            },
            "longitude" : {
                "type" : "number",
                "description" : "Longitude coordinate (in decimal format) of the AP"
            },
            "location" : {
                "type" : "string",
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "location of the AP. It is a text description to indicate the location of the AP."
            },
            "provisionChecklist" : {
                "description" : "provision checklist of the AP. This field indicate the steps completed during provisioning of the AP.",
                "type" : "string"
            },
            "administrativeState" : {
                "description" : "administrative state of the AP. A locked AP will not provide any WLAN services.",
                "enum" : [ "Locked", "Unlocked" ],
                "default" : "Unlocked"
            },
            "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."
            },
            "syslog" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "description" : "Indicates whether syslog is enabled or disabled",
                        "type" : "boolean"
                    },
                    "address" : {
                        "type" : "string",
                        "pattern" : "^(((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))$",
                        "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" : 65536
                    },
                    "facility" : {
                        "description" : "Facility of the syslog server",
                        "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                    },
                    "priority" : {
                        "description" : "Priority of the log messages",
                        "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                    }
                },
                "required" : [ "enabled" ],
                "description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level."
            },
            "wifi24" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "txPower" : {
                        "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                        "description" : "Transmission power"
                    },
                    "channelWidth" : {
                        "description" : "Channel width",
                        "enum" : [ 0, 20, 40 ]
                    },
                    "channel" : {
                        "description" : "Channel number",
                        "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
                    }
                },
                "description" : "2.4GHz radio configuration of the AP. This configuration will override the radio 2.4GHz configuration at the zone level or AP group level."
            },
            "wifi50" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "txPower" : {
                        "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                        "description" : "Transmission power"
                    },
                    "channelWidth" : {
                        "description" : "Channel width. Zero (0) means Auto.",
                        "enum" : [ 0, 20, 40, 80 ]
                    },
                    "indoorChannel" : {
                        "description" : "Indoor channel number",
                        "enum" : [ 0, 36, 40, 44, 48, 149, 153, 157, 161 ]
                    },
                    "outdoorChannel" : {
                        "description" : "Outdoor channel number",
                        "enum" : [ 0, 149, 153, 157, 161 ]
                    }
                },
                "description" : "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level."
            },
            "wlanGroup24" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Identifier of the WLAN group",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the WLAN group",
                        "type" : "string"
                    }
                },
                "description" : "WLAN group of 2.4GHz radio. This configuration will override the WLAN group of the 2.4GHz radio at the zone level or AP group level."
            },
            "wlanGroup50" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Identifier of the WLAN group",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the WLAN group",
                        "type" : "string"
                    }
                },
                "description" : "WLAN group of 5GHz radio. This configuration will override the WLAN group of the 5GHz radio at the zone level or AP group level."
            },
            "network" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "ipType" : {
                        "description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
                        "enum" : [ "Static", "Dynamic", "Keep" ]
                    },
                    "ip" : {
                        "type" : "string",
                        "pattern" : "^(((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))$",
                        "description" : "IP address of the AP"
                    },
                    "netmask" : {
                        "type" : "string",
                        "pattern" : "(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)",
                        "description" : "Netmask of the AP's subnet"
                    },
                    "gateway" : {
                        "type" : "string",
                        "pattern" : "^(((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))$",
                        "description" : "Gateway of the AP"
                    },
                    "primaryDns" : {
                        "type" : "string",
                        "pattern" : "^(((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))$",
                        "description" : "Primary DNS server address of the AP"
                    },
                    "secondaryDns" : {
                        "type" : "string",
                        "pattern" : "^(((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))$",
                        "description" : "Secondary DNS server address of the AP"
                    }
                },
                "description" : "Network settings of the AP."
            }
        }
    }
    
    

Retrieve AP Picture 

/v1_0/aps/{apMac}/picture

Use this API command to retrieve the current AP picture.

  • Response  200
  • Body
    Binary data for the picture
    
    

Create 

/v1_0/aps

Use this API command to create a new access point.

  • Request
  • Body
    {
        "mac" : "00:11:22:33:44:55",
        "zoneId" : "zoneUUID",
        "apGroupId" : "apGroupUUID",
        "serial" : "00000096",
        "model" : "ZF7962",
        "name" : "apName",
        "latitude" : 22.3,
        "longitude" : 114,
        "location" : "shenzhen",
        "description" : "apDescription",
        "administrativeState" : "Unlocked",
        "provisionChecklist" : "test"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "mac" : {
                "type" : "string",
                "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
                "description" : "MAC address of the AP"
            },
            "zoneId" : {
                "description" : "Identifier of the zone to which the AP belongs",
                "type" : "string"
            },
            "apGroupId" : {
                "description" : "Identifier of the AP group to which the AP belongs. If the AP belongs to the default AP group, this property is not needed.",
                "type" : "string"
            },
            "serial" : {
                "description" : "Serial number of the AP",
                "type" : "string"
            },
            "model" : {
                "description" : "Model name of the AP",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 64,
                "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
                "description" : "Name of the AP"
            },
            "latitude" : {
                "type" : "number",
                "description" : "Latitude coordinate (in decimal format) of the AP"
            },
            "longitude" : {
                "type" : "number",
                "description" : "Longitude coordinate (in decimal format) of the AP"
            },
            "location" : {
                "type" : "string",
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Location of the AP. This is a free format text description that indicates the location of the AP."
            },
            "description" : {
                "type" : "string",
                "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 

/v1_0/aps/{apMac}

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

  • Request
  • Body
    {
        "zoneId" : "zoneUUID",
        "apGroupId" : "apGroupUUID",
        "serial" : "00000096",
        "model" : "ZF7343",
        "name" : "apName",
        "latitude" : 22.3,
        "longitude" : 114,
        "location" : "location",
        "description" : "apDescription",
        "administrativeState" : "Unlocked",
        "provisionChecklist" : "provisionChecklist"
    }
    
    
    Schema
    {
        "zoneId" : {
            "description" : "Identifier of the zone to which the AP belongs",
            "type" : "string"
        },
        "apGroupId" : {
            "description" : "Identifier of the AP group to which the AP belongs",
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "model" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
            "description" : "Name of the AP"
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the AP"
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the AP"
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the AP. This is a text description that indicates the location of the AP."
        },
        "description" : {
            "type" : "string",
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the AP"
        },
        "administrativeState" : {
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "enum" : [ "Locked", "Unlocked" ]
        },
        "provisionChecklist" : {
            "description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
            "type" : "string"
        }
    }
    
    
  • Response  204

Modify Login Override 

/v1_0/aps/{apMac}/login

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

  • Request
  • 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" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level."
    }
    
    
  • Response  204

Diable Login Override 

/v1_0/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 

/v1_0/aps/{apMac}/syslog

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

  • Request
  • Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "enabled" : {
                "description" : "Indicates whether syslog is enabled or disabled",
                "type" : "boolean"
            },
            "address" : {
                "type" : "string",
                "pattern" : "^(((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))$",
                "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" : 65536
            },
            "facility" : {
                "description" : "Facility of the syslog server",
                "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
            },
            "priority" : {
                "description" : "Priority of the log messages",
                "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
            }
        },
        "required" : [ "enabled" ],
        "description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level."
    }
    
    
  • Response  204

Diable Syslog Override 

/v1_0/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 

/v1_0/aps/{apMac}/wifi24

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

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

Disable Radio 2.4G Override 

/v1_0/aps/{apMac}/wifi24

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

  • Response  204

Modify Radio 5G Override 

/v1_0/aps/{apMac}/wifi50

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

  • Request
  • Body
    {
        "txPower" : "txPower",
        "channelWidth" : 1,
        "indoorChannel" : 1,
        "outdoorChannel" : 2
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "txPower" : {
                "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                "description" : "Transmission power"
            },
            "channelWidth" : {
                "description" : "Channel width. Zero (0) means Auto.",
                "enum" : [ 0, 20, 40, 80 ]
            },
            "indoorChannel" : {
                "description" : "Indoor channel number",
                "enum" : [ 0, 36, 40, 44, 48, 149, 153, 157, 161 ]
            },
            "outdoorChannel" : {
                "description" : "Outdoor channel number",
                "enum" : [ 0, 149, 153, 157, 161 ]
            }
        },
        "description" : "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 

/v1_0/aps/{apMac}/wifi50

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

  • Response  204

Modify WLAN Group 2.4G Override 

/v1_0/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
  • 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 

/v1_0/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 

/v1_0/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
  • 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 

/v1_0/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 

/v1_0/aps/{apMac}/network

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

  • Request
  • Body
    {
        "ipType" : "Static",
        "ip" : "1.1.1.1",
        "netmask" : "255.255.255.0",
        "gateway" : "1.1.1.0",
        "primaryDns" : "8.8.8.8",
        "secondaryDns" : "8.8.8.9"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "ipType" : {
                "description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
                "enum" : [ "Static", "Dynamic", "Keep" ]
            },
            "ip" : {
                "type" : "string",
                "pattern" : "^(((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))$",
                "description" : "IP address of the AP"
            },
            "netmask" : {
                "type" : "string",
                "pattern" : "(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)",
                "description" : "Netmask of the AP's subnet"
            },
            "gateway" : {
                "type" : "string",
                "pattern" : "^(((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))$",
                "description" : "Gateway of the AP"
            },
            "primaryDns" : {
                "type" : "string",
                "pattern" : "^(((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))$",
                "description" : "Primary DNS server address of the AP"
            },
            "secondaryDns" : {
                "type" : "string",
                "pattern" : "^(((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))$",
                "description" : "Secondary DNS server address of the AP"
            }
        },
        "description" : "Network settings of the AP."
    }
    
    
  • Response  204

Upload AP Picture 

/v1_0/aps/{apMac}/picture

Use this API command to upload a new AP picture.

  • Request
  • Body
    Binary data for the picture
    
    
  • Response  204

Modify AP Picture 

/v1_0/aps/{apMac}/picture

Use this API command to modify an AP picture

  • Request
  • Body
    Binary data for the picture
    
    
  • Response  204

Delete AP Picture 

/v1_0/aps/{apMac}/picture

Use this API command to delete an AP picture.

  • Response  204

Delete 

/v1_0/aps/{apMac}

Use this API command to delete an access point.

  • Response  204

Access Point Operational 

Retrieve Operational Information 

/v1_0/aps/{apMac}/operational/summary

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

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

Retrieve Alarm Summary 

/v1_0/aps/{apMac}/operational/alarmSummary

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

  • Response  200
  • Body
    {
        "criticalCount" : 3,
        "majorCount" : 3,
        "minorCount" : 4,
        "warningCount" : 0
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "criticalCount" : {
                "description" : "Critical alarm count",
                "type" : "integer"
            },
            "majorCount" : {
                "description" : "Major alarm count",
                "type" : "integer"
            },
            "minorCount" : {
                "description" : "Minor alarm count",
                "type" : "integer"
            },
            "warningCount" : {
                "description" : "Warning alarm count",
                "type" : "integer"
            }
        }
    }
    
    

Retrieve Event Summary 

/v1_0/aps/{apMac}/operational/eventSummary

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

  • Response  200
  • Body
    {
        "criticalCount" : 4,
        "majorCount" : 2,
        "minorCount" : 5,
        "warningCount" : 5,
        "informationalCount" : 2,
        "debugCount" : 5
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "criticalCount" : {
                "description" : "Critical event count",
                "type" : "integer"
            },
            "majorCount" : {
                "description" : "Major event count",
                "type" : "integer"
            },
            "minorCount" : {
                "description" : "Minor event count",
                "type" : "integer"
            },
            "warningCount" : {
                "description" : "Warning event count",
                "type" : "integer"
            },
            "informationalCount" : {
                "description" : "Informational event count",
                "type" : "integer"
            },
            "debugCount" : {
                "description" : "Debug event count",
                "type" : "integer"
            }
        }
    }
    
    

Retrieve Alarm List 

/v1_0/aps/{apMac}/operational/alarms

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

  • Parameters
  • index
    number (optional) 

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

    listSize
    number (optional) 

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

    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
  • 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])$",
                            "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 

/v1_0/aps/{apMac}/operational/events

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

  • Parameters
  • index
    number (optional) 

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

    listSize
    number (optional) 

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

    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
  • 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])$",
                            "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"
                        }
                    }
                }
            }
        }
    }
    
    

WLAN Group 

Retrieve List 

/v1_0/rkszones/{zoneId}/wlangroups

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

  • Parameters
  • index
    number (optional) 

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

    listSize
    number (optional) 

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

  • Response  200
  • Body
    {
        "totalCount" : 2,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "wlanGroupUUID",
            "zoneId" : "zoneUUID",
            "name" : "wlanGroupName",
            "description" : "wlanGroupDescription",
            "members" : [ {
                "id" : "wlanUUID",
                "accessVlan" : 1
            } ]
        }, {
            "id" : "wlanGroupUUID2",
            "zoneId" : "zoneUUID",
            "name" : "wlanGroupName2",
            "description" : "wlanGroupDescription2",
            "members" : [ {
                "id" : "wlanUUID2",
                "accessVlan" : 1
            } ]
        } ]
    }
    
    
    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",
                            "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. Zero (0) means not overriden.",
                                        "type" : "integer",
                                        "minimum" : 0,
                                        "maximum" : 4094
                                    }
                                },
                                "required" : [ "id" ]
                            }
                        }
                    },
                    "required" : [ "name" ]
                }
            }
        }
    }
    
    

Retrieve 

/v1_0/rkszones/{zoneId}/wlangroups/{id}

Use this API command to retrieve the WLAN group.

  • Response  200
  • 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",
                "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. Zero (0) means not overriden.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 4094
                        }
                    },
                    "required" : [ "id" ]
                }
            }
        },
        "required" : [ "name" ]
    }
    
    

Create 

/v1_0/rkszones/{zoneId}/wlangroups

Use this API command to create a new WLAN group.

  • Request
  • 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",
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN group"
            }
        },
        "required" : [ "name" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanGroupUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the WLAN group",
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v1_0/rkszones/{zoneId}/wlangroups/{id}

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

  • Request
  • 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",
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN group"
        }
    }
    
    
  • Response  204

Add Member 

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

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

  • Request
  • Body
    {
        "id" : "wlanUUID",
        "accessVlan" : 1
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the WLAN",
                "type" : "string"
            },
            "accessVlan" : {
                "description" : "Access VLAN. Zero (0) means not overriden.",
                "type" : "integer",
                "minimum" : 0,
                "maximum" : 4094
            }
        },
        "required" : [ "id" ]
    }
    
    
  • Response  201

Modify Member 

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

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

  • Request
  • Body
    {
        "accessVlan" : 23
    }
    
    
    Schema
    {
        "accessVlan" : {
            "description" : "Access VLAN. Zero (0) means not overriden.",
            "type" : "integer",
            "minimum" : 0,
            "maximum" : 4094
        }
    }
    
    
  • Response  204

Remove Member 

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

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

  • Response  204

Delete 

/v1_0/rkszones/{zoneId}/wlangroups/{id}

Use this API command to delete a WLAN group.

  • Response  204

WLAN 

Retrieve List 

/v1_0/rkszones/{zoneId}/wlans

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

  • Parameters
  • index
    number (optional) 

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

    listSize
    number (optional) 

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

  • Response  200
  • Body
    {
        "totalCount" : 2,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "1028",
            "name" : "wlan2",
            "ssid" : "wlan2"
        }, {
            "id" : "1027",
            "zoneId" : "21a18b1c-e260-48c8-866c-69e66c81368e",
            "name" : "wlan1",
            "ssid" : "wlan1"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the WLAN",
                            "type" : "string"
                        },
                        "mvnoId" : {
                            "description" : "Tenant UUID",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the WLAN",
                            "type" : "string"
                        },
                        "ssid" : {
                            "description" : "SSID of the WLAN",
                            "type" : "string"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve 

/v1_0/rkszones/{zoneId}/wlans/{id}

Use this API command to retrieve a WLAN.

  • Response  200
  • Body
    {
        "id" : "1027",
        "zoneId" : "21a18b1c-e260-48c8-866c-69e66c81368e",
        "name" : "wlan1",
        "ssid" : "wlan1",
        "description" : "",
        "type" : "Standard_Open",
        "encryption" : {
            "method" : "None"
        },
        "macAuth" : null,
        "authServiceOrProfile" : null,
        "accountingServiceOrProfile" : {
            "id" : "",
            "name" : null,
            "throughController" : false,
            "interimUpdateMin" : null,
            "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" : 1,
            "dynamicVlanEnabled" : false
        },
        "schedule" : {
            "id" : null,
            "name" : null,
            "type" : "AlwaysOn"
        },
        "radiusOptions" : {
            "nasIdType" : "WLAN_BSSID",
            "customizedNasId" : null,
            "nasRequestTimeoutSec" : 3,
            "nasMaxRetry" : 2,
            "nasReconnectPrimaryMin" : 5,
            "calledStaIdType" : "WLAN_BSSID"
        },
        "advancedOptions" : {
            "uplinkRateLimiting" : "Disable",
            "downlinkRateLimiting" : "Disable",
            "clientIsolcationEnabled" : false,
            "priority" : "High",
            "zeroItActivationEnabled" : false,
            "hideSsidEnabled" : true,
            "clientLoadBalancingEnabled" : true,
            "proxyARPEnabled" : false,
            "dgafEnabled" : null,
            "maxClientsPerRadio" : 100,
            "support80211dEnabled" : false,
            "forceDHCPEnabled" : false,
            "forceClientDHCPTimeout" : 10,
            "dhcpOption82Enabled" : false,
            "dhcp82Format" : "RUCKUS_DEFAULT",
            "unauthClientStatsEnabled" : false,
            "clientIdleTimeoutSec" : 120,
            "clientFingerprintingEnabled" : false,
            "ofdmOnlyEnabled" : false,
            "bssMinRateMbps" : "Disable",
            "mgmtTxRateMbps" : "2 mbps",
            "bandBalancing" : "UseZoneSetting"
        }
    }
    
    
    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"
            },
            "description" : {
                "description" : "Description of the WLAN",
                "type" : "string"
            },
            "type" : {
                "description" : "Type of WLAN",
                "enum" : [ "Standard_Open", "Standard_80211", "Standard_Mac", "Hotspot", "Hotspot_MacByPass", "Guest", "WebAuth", "Hotspot20" ]
            },
            "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"
                    },
                    "keyIndex" : {
                        "description" : "Key index. This only applies to WEP64 and WEP128.",
                        "type" : "integer"
                    },
                    "keyInHex" : {
                        "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                        "type" : "string"
                    }
                },
                "required" : [ "method" ],
                "description" : "Encryption method used by the WLAN"
            },
            "authServiceOrProfile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "throughController" : {
                        "description" : "Indicates whether authentication messages were sent through the controller or not",
                        "type" : "boolean"
                    },
                    "id" : {
                        "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    }
                },
                "description" : "Authentication method used by the WLAN"
            },
            "macAuth" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "macAuthMacFormat" : {
                        "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                        "enum" : [ "Default", "802.1X" ]
                    },
                    "customizedPassword" : {
                        "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                        "type" : "string",
                        "maxLength" : 64,
                        "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                    }
                },
                "description" : "MAC authentication of the WLAN"
            },
            "accountingServiceOrProfile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "throughController" : {
                        "description" : "Indicates whether accounting messages were sent through the controller",
                        "type" : "boolean"
                    },
                    "id" : {
                        "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                        "type" : "string"
                    },
                    "interimUpdateMin" : {
                        "description" : "Interval (in minutes) for sending interim updates",
                        "type" : "integer",
                        "minimum" : 0,
                        "maximum" : 1440
                    },
                    "accountingDelayEnabled" : {
                        "description" : "Indicates whether accounting delay time is enabled",
                        "type" : "boolean"
                    },
                    "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",
                "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",
                "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",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "User traffic profile of the WLAN"
            },
            "vlan" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "accessVlan" : {
                        "description" : "Access VLAN ID",
                        "type" : "integer",
                        "minimum" : 0,
                        "maximum" : 4094
                    },
                    "dynamicVlanEnabled" : {
                        "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                        "type" : "boolean"
                    }
                },
                "description" : "VLAN (access and/or core) of the WLAN."
            },
            "l2ACL" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Layer 2 ACL of the WLAN"
            },
            "devicePolicy" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Device policy of the WLAN"
            },
            "radiusOptions" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "nasIdType" : {
                        "description" : "NAS ID type",
                        "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                        "default" : "WLAN_BSSID"
                    },
                    "customizedNasId" : {
                        "description" : "User defined NAS ID",
                        "type" : "string",
                        "maxLength" : 63,
                        "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
                    },
                    "nasRequestTimeoutSec" : {
                        "description" : "NAS request timeout in seconds",
                        "type" : "integer",
                        "default" : 3,
                        "minimum" : 2,
                        "maximum" : 20
                    },
                    "nasMaxRetry" : {
                        "description" : "NAS request maximum retry",
                        "type" : "integer",
                        "default" : 2,
                        "minimum" : 2,
                        "maximum" : 10
                    },
                    "nasReconnectPrimaryMin" : {
                        "description" : "NAS reconnect primary time in minutes",
                        "type" : "integer",
                        "default" : 5,
                        "minimum" : 1,
                        "maximum" : 60
                    },
                    "calledStaIdType" : {
                        "description" : "Called station ID type",
                        "enum" : [ "WLAN_BSSID", "AP_MAC" ],
                        "default" : "WLAN_BSSID"
                    }
                },
                "description" : "RADIUS options of the WLAN."
            },
            "schedule" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "type" : {
                        "description" : "Type of WLAN schedule",
                        "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                    },
                    "id" : {
                        "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    }
                },
                "required" : [ "type" ],
                "description" : "Schedule of the WLAN."
            },
            "advancedOptions" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "clientIsolationEnabled" : {
                        "description" : "Indicates whether wireless client isolation is enabled or disabled",
                        "type" : "boolean",
                        "default" : true
                    },
                    "priority" : {
                        "description" : "Priority of the WLAN",
                        "enum" : [ "High", "Low" ],
                        "default" : "High"
                    },
                    "hideSsidEnabled" : {
                        "description" : "Indicates whether the SSID is hidden or broadcast",
                        "type" : "boolean",
                        "default" : false
                    },
                    "maxClientsPerRadio" : {
                        "description" : "Maximum number of clients per radio",
                        "type" : "integer",
                        "default" : 100,
                        "minimum" : 1,
                        "maximum" : 512
                    },
                    "clientIdleTimeoutSec" : {
                        "description" : "Client idle timeout in seconds",
                        "type" : "integer",
                        "minimum" : 60,
                        "maximum" : 1000,
                        "default" : 120
                    },
                    "dgafEnabled" : {
                        "description" : "Indicates whether dgaf is enabled or disabled",
                        "type" : "boolean"
                    },
                    "proxyARPEnabled" : {
                        "description" : "Indicates whether proxy ARP is enabled or disabled",
                        "type" : "boolean",
                        "default" : false
                    },
                    "support80211dEnabled" : {
                        "description" : "Indicates whether support for 802.11d is enabled or disabled",
                        "type" : "boolean",
                        "default" : false
                    },
                    "forceClientDHCPTimeoutSec" : {
                        "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                        "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
                        "default" : 0
                    },
                    "dhcpOption82Enabled" : {
                        "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                        "type" : "boolean",
                        "default" : false
                    },
                    "dhcp82Format" : {
                        "description" : "DHCP Option 82 format",
                        "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                    },
                    "unauthClientStatsEnabled" : {
                        "description" : "Indicates whether to send statistics of unauthorized clients or not",
                        "type" : "boolean",
                        "default" : true
                    },
                    "clientFingerprintingEnabled" : {
                        "description" : "Indicates whether client fingerprinting is enabled or disabled",
                        "type" : "boolean",
                        "default" : false
                    },
                    "ofdmOnlyEnabled" : {
                        "description" : "Indicates whether OFDM only is enabled or disabled",
                        "type" : "boolean",
                        "default" : false
                    },
                    "bandBalancing" : {
                        "description" : "Indicates whether band balancing is enabled or disabled",
                        "enum" : [ "Disabled", "UseZoneSetting" ],
                        "default" : "UseZoneSetting"
                    },
                    "bssMinRateMbps" : {
                        "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                        "description" : "bss minimum rate (mbps)"
                    },
                    "mgmtTxRateMbps" : {
                        "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                        "description" : "Management TX rate (mbps)"
                    },
                    "uplinkRateLimiting" : {
                        "enum" : [ "Disable", "0.10 mbps", "0.25 mbps", "0.50 mbps", "0.75 mbps", "1.00 mbps", "1.25 mbps", "1.50 mbps", "1.75 mbps", "2.00 mbps", "2.25 mbps", "2.50 mbps", "2.75 mbps", "3.00 mbps", "3.25 mbps", "3.50 mbps", "3.75 mbps", "4.00 mbps", "4.25 mbps", "4.50 mbps", "4.75 mbps", "5.00 mbps", "5.25 mbps", "5.50 mbps", "5.75 mbps", "6.00 mbps", "6.25 mbps", "6.50 mbps", "6.75 mbps", "7.00 mbps", "7.25 mbps", "7.50 mbps", "7.75 mbps", "8.00 mbps", "8.25 mbps", "8.50 mbps", "8.75 mbps", "9.00 mbps", "9.25 mbps", "9.50 mbps", "9.75 mbps", "10.00 mbps", "10.25 mbps", "10.50 mbps", "10.75 mbps", "11.00 mbps", "11.25 mbps", "11.50 mbps", "11.75 mbps", "12.00 mbps", "12.25 mbps", "12.50 mbps", "12.75 mbps", "13.00 mbps", "13.25 mbps", "13.50 mbps", "13.75 mbps", "14.00 mbps", "14.25 mbps", "14.50 mbps", "14.75 mbps", "15.00 mbps", "15.25 mbps", "15.50 mbps", "15.75 mbps", "16.00 mbps", "16.25 mbps", "16.50 mbps", "16.75 mbps", "17.00 mbps", "17.25 mbps", "17.50 mbps", "17.75 mbps", "18.00 mbps", "18.25 mbps", "18.50 mbps", "18.75 mbps", "19.00 mbps", "19.25 mbps", "19.50 mbps", "19.75 mbps", "20.00 mbps" ],
                        "description" : "Uplink rate limiting (mbps)"
                    },
                    "downlinkRateLimiting" : {
                        "enum" : [ "Disable", "0.10 mbps", "0.25 mbps", "0.50 mbps", "0.75 mbps", "1.00 mbps", "1.25 mbps", "1.50 mbps", "1.75 mbps", "2.00 mbps", "2.25 mbps", "2.50 mbps", "2.75 mbps", "3.00 mbps", "3.25 mbps", "3.50 mbps", "3.75 mbps", "4.00 mbps", "4.25 mbps", "4.50 mbps", "4.75 mbps", "5.00 mbps", "5.25 mbps", "5.50 mbps", "5.75 mbps", "6.00 mbps", "6.25 mbps", "6.50 mbps", "6.75 mbps", "7.00 mbps", "7.25 mbps", "7.50 mbps", "7.75 mbps", "8.00 mbps", "8.25 mbps", "8.50 mbps", "8.75 mbps", "9.00 mbps", "9.25 mbps", "9.50 mbps", "9.75 mbps", "10.00 mbps", "10.25 mbps", "10.50 mbps", "10.75 mbps", "11.00 mbps", "11.25 mbps", "11.50 mbps", "11.75 mbps", "12.00 mbps", "12.25 mbps", "12.50 mbps", "12.75 mbps", "13.00 mbps", "13.25 mbps", "13.50 mbps", "13.75 mbps", "14.00 mbps", "14.25 mbps", "14.50 mbps", "14.75 mbps", "15.00 mbps", "15.25 mbps", "15.50 mbps", "15.75 mbps", "16.00 mbps", "16.25 mbps", "16.50 mbps", "16.75 mbps", "17.00 mbps", "17.25 mbps", "17.50 mbps", "17.75 mbps", "18.00 mbps", "18.25 mbps", "18.50 mbps", "18.75 mbps", "19.00 mbps", "19.25 mbps", "19.50 mbps", "19.75 mbps", "20.00 mbps" ],
                        "description" : "Download rate limiting (mbps)"
                    },
                    "zeroItActivationEnabled" : {
                        "description" : "Indicates whether Zero-IT activation is enabled or disabled",
                        "type" : "boolean",
                        "default" : false
                    }
                },
                "description" : "Advanced settings for the WLAN."
            }
        }
    }
    
    

Create - Standard Open 

/v1_0/rkszones/{zoneId}/wlans

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

  • Request
  • Body
    {
        "name" : "wlanName",
        "ssid" : "wlanSSID",
        "description" : "wlanDescription"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the WLAN"
            },
            "ssid" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "SSID of the WLAN"
            },
            "description" : {
                "type" : "string",
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            }
        },
        "required" : [ "name", "ssid" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create - 802.1X 

/v1_0/rkszones/{zoneId}/wlans/standard80211

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

  • Request
  • Body
    {
        "name" : "wlanName",
        "ssid" : "wlanSSID",
        "description" : "wlanDescription",
        "authServiceOrProfile" : {
            "throughController" : false,
            "id" : "authServiceUUID",
            "name" : "authServiceName"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the WLAN"
            },
            "ssid" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "SSID of the WLAN"
            },
            "description" : {
                "type" : "string",
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            },
            "authServiceOrProfile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "throughController" : {
                        "description" : "Indicates whether authentication messages were sent through the controller or not",
                        "type" : "boolean"
                    },
                    "id" : {
                        "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    }
                },
                "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required."
            }
        },
        "required" : [ "name", "ssid", "authServiceOrProfile" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create - MAC Auth 

/v1_0/rkszones/{zoneId}/wlans/standardmac

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

  • Request
  • Body
    {
        "name" : "wlanName",
        "ssid" : "wlanSSID",
        "description" : "wlanDescription",
        "authServiceOrProfile" : {
            "throughController" : false,
            "id" : "authServiceUUID",
            "name" : "authServiceName"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the WLAN"
            },
            "ssid" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "SSID of the WLAN"
            },
            "description" : {
                "type" : "string",
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            },
            "authServiceOrProfile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "throughController" : {
                        "description" : "Indicates whether authentication messages were sent through the controller or not",
                        "type" : "boolean"
                    },
                    "id" : {
                        "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    }
                },
                "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required."
            }
        },
        "required" : [ "name", "ssid", "authServiceOrProfile" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create - Hotspot 

/v1_0/rkszones/{zoneId}/wlans/wispr

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

  • Request
  • Body
    {
        "name" : "wlanName",
        "ssid" : "wlanSSID",
        "description" : "wlanDescription",
        "authServiceOrProfile" : {
            "throughController" : false,
            "id" : "authServiceUUID",
            "name" : "authServiceName"
        },
        "portalServiceProfile" : {
            "id" : "portalServiceUUID",
            "name" : "portalServiceName"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the WLAN"
            },
            "ssid" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "SSID of the WLAN"
            },
            "description" : {
                "type" : "string",
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            },
            "authServiceOrProfile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "throughController" : {
                        "description" : "Indicates whether authentication messages were sent through the controller or not",
                        "type" : "boolean"
                    },
                    "id" : {
                        "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    }
                },
                "description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required."
            },
            "portalServiceProfile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required."
            }
        },
        "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create - Hotspot + MAC bypass 

/v1_0/rkszones/{zoneId}/wlans/wisprmac

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

  • Request
  • Body
    {
        "name" : "wlanName",
        "ssid" : "wlanSSID",
        "description" : "wlanDescription",
        "authServiceOrProfile" : {
            "throughController" : false,
            "id" : "authServiceUUID",
            "name" : "authServiceName"
        },
        "portalServiceProfile" : {
            "id" : "portalServiceUUID",
            "name" : "portalServiceName"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the WLAN"
            },
            "ssid" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "SSID of the WLAN"
            },
            "description" : {
                "type" : "string",
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            },
            "authServiceOrProfile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "throughController" : {
                        "description" : "Indicates whether authentication messages were sent through the controller or not",
                        "type" : "boolean"
                    },
                    "id" : {
                        "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    }
                },
                "description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required."
            },
            "portalServiceProfile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required."
            }
        },
        "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create - Guest Access 

/v1_0/rkszones/{zoneId}/wlans/guest

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

  • Request
  • Body
    {
        "name" : "wlanName",
        "ssid" : "wlanSSID",
        "description" : "wlanDescription",
        "authServiceOrProfile" : {
            "throughController" : false,
            "id" : "authServiceUUID",
            "name" : "authServiceName"
        },
        "portalServiceProfile" : {
            "id" : "portalServiceUUID",
            "name" : "portalServiceName"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the WLAN"
            },
            "ssid" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "SSID of the WLAN"
            },
            "description" : {
                "type" : "string",
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            },
            "authServiceOrProfile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "throughController" : {
                        "description" : "Indicates whether authentication messages were sent through the controller or not",
                        "type" : "boolean"
                    },
                    "id" : {
                        "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    }
                },
                "description" : "Authentication of the WLAN. Guest WLANs only accept two names: Local DB and Always Accept."
            },
            "portalServiceProfile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Guest portal service of the WLAN. The ID or name of the guest portal services within the zone is required."
            }
        },
        "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create - Web Auth 

/v1_0/rkszones/{zoneId}/wlans/webauth

Use this API command to creates new web authentication WLAN.

  • Request
  • Body
    {
        "name" : "wlanName",
        "ssid" : "wlanSSID",
        "description" : "wlanDescription",
        "authServiceOrProfile" : {
            "throughController" : false,
            "id" : "authServiceUUID",
            "name" : "authServiceName"
        },
        "portalServiceProfile" : {
            "id" : "portalServiceUUID",
            "name" : "portalServiceName"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the WLAN"
            },
            "ssid" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "SSID of the WLAN"
            },
            "description" : {
                "type" : "string",
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            },
            "authServiceOrProfile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "throughController" : {
                        "description" : "Indicates whether authentication messages were sent through the controller or not",
                        "type" : "boolean"
                    },
                    "id" : {
                        "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    }
                },
                "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required."
            },
            "portalServiceProfile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Web authorizationn portal service of the WLAN. The ID or name of the guest portal services within the zone is required."
            }
        },
        "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    
/v1_0/rkszones/{zoneId}/wlans/webauth

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

  • Request
  • Body
    {
        "name" : "wlanName",
        "ssid" : "wlanSSID",
        "description" : "wlanDescription",
        "authServiceOrProfile" : {
            "throughController" : false,
            "id" : "authServiceUUID",
            "name" : "authServiceName"
        },
        "hotspot20Profile" : {
            "id" : "hotspot20ServiceUUID",
            "name" : "hotspot20ServiceName"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the WLAN"
            },
            "ssid" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "SSID of the WLAN"
            },
            "description" : {
                "type" : "string",
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            },
            "authServiceOrProfile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "throughController" : {
                        "description" : "Indicates whether authentication messages were sent through the controller or not",
                        "type" : "boolean"
                    },
                    "id" : {
                        "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    }
                },
                "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."
            },
            "hotspot20Profile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Hotspot 2.0 operator profile of the WLAN. The ID or name of the Hotspot 2.0 operator profiles within the zone is required."
            }
        },
        "required" : [ "name", "ssid", "authServiceOrProfile", "hotspot20Profile" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v1_0/rkszones/{zoneId}/wlans/{id}

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

  • Request
  • Body
    {
        "name" : "wlanName",
        "ssid" : "wlanSSID",
        "description" : "wlanDescription",
        "accessTunnelType" : "RuckusGRE"
    }
    
    
    Schema
    {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "SSID of the WLAN"
        },
        "description" : {
            "type" : "string",
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "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" ]
        }
    }
    
    
  • Response  204

Modify Authentication 

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

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

  • Request
  • Body
    {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "throughController" : {
                "description" : "Indicates whether authentication messages were sent through the controller or not",
                "type" : "boolean"
            },
            "id" : {
                "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                "type" : "string"
            },
            "name" : {
                "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                "type" : "string"
            }
        },
        "description" : "Authentication method used by the WLAN"
    }
    
    
  • Response  204

Modify MAC Auth 

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

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

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

Modify Accounting 

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

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

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

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

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

  • Response  204

Modify Encryption 

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

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

  • Request
  • Body
    {
        "method" : "WPA2",
        "algorithm" : "AES",
        "passphrase" : "password"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "method" : {
                "description" : "Encryption method",
                "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
            },
            "algorithm" : {
                "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                "enum" : [ "AES", "TKIP_AES" ]
            },
            "passphrase" : {
                "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                "type" : "string"
            },
            "keyIndex" : {
                "description" : "Key index. This only applies to WEP64 and WEP128.",
                "type" : "integer"
            },
            "keyInHex" : {
                "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                "type" : "string"
            }
        },
        "required" : [ "method" ],
        "description" : "Encryption of the WLAN"
    }
    
    
  • Response  204

Modify Portal Profile 

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

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

  • Request
  • Body
    {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
    
    
    Schema
    {
        "type" : "object",
        "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 

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

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

  • Request
  • Body
    {
        "id" : "hotspot20ServiceUUID",
        "name" : "hotspot20ServiceName"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            },
            "name" : {
                "type" : "string"
            }
        },
        "description" : "Hotspot 2.0 operator profile of the WLAN. This only applies to Hotspot 2.0 WLANs."
    }
    
    
  • Response  204

Modify User Traffic Profile 

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

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

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

Modify Schedule 

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

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

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

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

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

  • Request
  • Body
    {
        "accessVlan" : 23,
        "dynamicVlanEnabled" : true
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "accessVlan" : {
                "description" : "Access VLAN ID",
                "type" : "integer",
                "minimum" : 0,
                "maximum" : 4094
            },
            "dynamicVlanEnabled" : {
                "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                "type" : "boolean"
            }
        },
        "description" : "VLAN (access and/or core) of the WLAN."
    }
    
    
  • Response  204

Modify Layer 2 ACL 

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

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

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

Disable Layer 2 ACL 

/v1_0/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 

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

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

  • Request
  • Body
    {
        "id" : "devicePolicyUUID",
        "name" : "devicePolicyName"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            },
            "name" : {
                "type" : "string"
            }
        },
        "description" : "device policy of the WLAN"
    }
    
    
  • Response  204

Disable Device Policy 

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

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

  • Response  204

Modify RADIUS Options 

/v1_0/rkszones/{zoneId}/wlans/{id}/radiusOptions

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

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

Modify Advanced Options 

/v1_0/rkszones/{zoneId}/wlans/{id}/advancedOptions

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

  • Request
  • Body
    {
        "clientIsolationEnabled" : false,
        "priority" : "High",
        "hideSsidEnabled" : true,
        "maxClientsPerRadio" : 12,
        "clientIdleTimeoutSec" : 12,
        "proxyARPEnabled" : true,
        "support80211dEnabled" : false,
        "forceDHCPEnabled" : false,
        "forceClientDHCPTimeout" : 21,
        "dhcpOption82Enabled" : true,
        "dhcp82Format" : "RUCKUS_DEFAULT",
        "unauthClientStatsEnabled" : false,
        "clientFingerprintingEnabled" : true,
        "ofdmOnlyEnabled" : false,
        "bandBalancing" : "UseZoneSetting",
        "bssMinRateMbps" : "Disable",
        "mgmtTxRateMbps" : "2 mbps",
        "uplinkRateLimiting" : "Disable",
        "downlinkRateLimiting" : "Disable",
        "zeroItActivationEnabled" : false
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "clientIsolationEnabled" : {
                "description" : "Indicates whether wireless client isolation is enabled or disabled",
                "type" : "boolean",
                "default" : true
            },
            "priority" : {
                "description" : "Priority of the WLAN",
                "enum" : [ "High", "Low" ],
                "default" : "High"
            },
            "hideSsidEnabled" : {
                "description" : "Indicates whether the SSID is hidden or broadcast",
                "type" : "boolean",
                "default" : false
            },
            "maxClientsPerRadio" : {
                "description" : "Maximum number of clients per radio",
                "type" : "integer",
                "default" : 100,
                "minimum" : 1,
                "maximum" : 512
            },
            "clientIdleTimeoutSec" : {
                "description" : "Client idle timeout in seconds",
                "type" : "integer",
                "minimum" : 60,
                "maximum" : 1000,
                "default" : 120
            },
            "dgafEnabled" : {
                "description" : "Indicates whether dgaf is enabled or disabled",
                "type" : "boolean"
            },
            "proxyARPEnabled" : {
                "description" : "Indicates whether proxy ARP is enabled or disabled",
                "type" : "boolean",
                "default" : false
            },
            "support80211dEnabled" : {
                "description" : "Indicates whether support for 802.11d is enabled or disabled",
                "type" : "boolean",
                "default" : false
            },
            "forceClientDHCPTimeoutSec" : {
                "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
                "default" : 0
            },
            "dhcpOption82Enabled" : {
                "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                "type" : "boolean",
                "default" : false
            },
            "dhcp82Format" : {
                "description" : "DHCP Option 82 format",
                "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
            },
            "unauthClientStatsEnabled" : {
                "description" : "Indicates whether to send statistics of unauthorized clients or not",
                "type" : "boolean",
                "default" : true
            },
            "clientFingerprintingEnabled" : {
                "description" : "Indicates whether client fingerprinting is enabled or disabled",
                "type" : "boolean",
                "default" : false
            },
            "ofdmOnlyEnabled" : {
                "description" : "Indicates whether OFDM only is enabled or disabled",
                "type" : "boolean",
                "default" : false
            },
            "bandBalancing" : {
                "description" : "Indicates whether band balancing is enabled or disabled",
                "enum" : [ "Disabled", "UseZoneSetting" ],
                "default" : "UseZoneSetting"
            },
            "bssMinRateMbps" : {
                "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                "description" : "bss minimum rate (mbps)"
            },
            "mgmtTxRateMbps" : {
                "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                "description" : "Management TX rate (mbps)"
            },
            "uplinkRateLimiting" : {
                "enum" : [ "Disable", "0.10 mbps", "0.25 mbps", "0.50 mbps", "0.75 mbps", "1.00 mbps", "1.25 mbps", "1.50 mbps", "1.75 mbps", "2.00 mbps", "2.25 mbps", "2.50 mbps", "2.75 mbps", "3.00 mbps", "3.25 mbps", "3.50 mbps", "3.75 mbps", "4.00 mbps", "4.25 mbps", "4.50 mbps", "4.75 mbps", "5.00 mbps", "5.25 mbps", "5.50 mbps", "5.75 mbps", "6.00 mbps", "6.25 mbps", "6.50 mbps", "6.75 mbps", "7.00 mbps", "7.25 mbps", "7.50 mbps", "7.75 mbps", "8.00 mbps", "8.25 mbps", "8.50 mbps", "8.75 mbps", "9.00 mbps", "9.25 mbps", "9.50 mbps", "9.75 mbps", "10.00 mbps", "10.25 mbps", "10.50 mbps", "10.75 mbps", "11.00 mbps", "11.25 mbps", "11.50 mbps", "11.75 mbps", "12.00 mbps", "12.25 mbps", "12.50 mbps", "12.75 mbps", "13.00 mbps", "13.25 mbps", "13.50 mbps", "13.75 mbps", "14.00 mbps", "14.25 mbps", "14.50 mbps", "14.75 mbps", "15.00 mbps", "15.25 mbps", "15.50 mbps", "15.75 mbps", "16.00 mbps", "16.25 mbps", "16.50 mbps", "16.75 mbps", "17.00 mbps", "17.25 mbps", "17.50 mbps", "17.75 mbps", "18.00 mbps", "18.25 mbps", "18.50 mbps", "18.75 mbps", "19.00 mbps", "19.25 mbps", "19.50 mbps", "19.75 mbps", "20.00 mbps" ],
                "description" : "Uplink rate limiting (mbps)"
            },
            "downlinkRateLimiting" : {
                "enum" : [ "Disable", "0.10 mbps", "0.25 mbps", "0.50 mbps", "0.75 mbps", "1.00 mbps", "1.25 mbps", "1.50 mbps", "1.75 mbps", "2.00 mbps", "2.25 mbps", "2.50 mbps", "2.75 mbps", "3.00 mbps", "3.25 mbps", "3.50 mbps", "3.75 mbps", "4.00 mbps", "4.25 mbps", "4.50 mbps", "4.75 mbps", "5.00 mbps", "5.25 mbps", "5.50 mbps", "5.75 mbps", "6.00 mbps", "6.25 mbps", "6.50 mbps", "6.75 mbps", "7.00 mbps", "7.25 mbps", "7.50 mbps", "7.75 mbps", "8.00 mbps", "8.25 mbps", "8.50 mbps", "8.75 mbps", "9.00 mbps", "9.25 mbps", "9.50 mbps", "9.75 mbps", "10.00 mbps", "10.25 mbps", "10.50 mbps", "10.75 mbps", "11.00 mbps", "11.25 mbps", "11.50 mbps", "11.75 mbps", "12.00 mbps", "12.25 mbps", "12.50 mbps", "12.75 mbps", "13.00 mbps", "13.25 mbps", "13.50 mbps", "13.75 mbps", "14.00 mbps", "14.25 mbps", "14.50 mbps", "14.75 mbps", "15.00 mbps", "15.25 mbps", "15.50 mbps", "15.75 mbps", "16.00 mbps", "16.25 mbps", "16.50 mbps", "16.75 mbps", "17.00 mbps", "17.25 mbps", "17.50 mbps", "17.75 mbps", "18.00 mbps", "18.25 mbps", "18.50 mbps", "18.75 mbps", "19.00 mbps", "19.25 mbps", "19.50 mbps", "19.75 mbps", "20.00 mbps" ],
                "description" : "Download rate limiting (mbps)"
            },
            "zeroItActivationEnabled" : {
                "description" : "Indicates whether Zero-IT activation is enabled or disabled",
                "type" : "boolean",
                "default" : false
            }
        },
        "description" : "Advanced settings for the WLAN."
    }
    
    
  • Response  204

Delete 

/v1_0/rkszones/{zoneId}/wlans/{id}

Use this API command to delete a WLAN.

  • Response  204

WLAN Scheduler 

Retrieve List 

/v1_0/rkszones/{zoneId}/wlanSchedulers

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

  • Parameters
  • index
    number (optional) 

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

    listSize
    number (optional) 

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

  • Response  200
  • Body
    {
        "totalCount" : 2,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "wlanSchedulerUUID",
            "name" : "wlanSchedulerName",
            "description" : "wlanSchedulerDescription",
            "sun" : [ "00:15-01:15", "07:00-08:30", "10:45-12:00" ],
            "mon" : [ "00:15-01:15" ],
            "tue" : [ "00:15-01:15" ],
            "wed" : [ "00:15-01:15" ],
            "thu" : [ "00:15-01:15" ],
            "fri" : [ "00:15-01:15" ],
            "sat" : [ "00:15-01:15" ]
        }, {
            "id" : "wlanSchedulerUUID2",
            "name" : "wlanSchedulerName2",
            "description" : "wlanSchedulerDescription2",
            "sun" : [ "00:15-01:15" ],
            "mon" : [ "00:15-01:15" ],
            "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" : [ "00:15-01:15" ]
        } ]
    }
    
    
    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",
                            "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 

/v1_0/rkszones/{zoneId}/wlanSchedulers/{id}

Use this API command to retrieve a WLAN schedule.

  • Response  200
  • Body
    {
        "id" : "wlanSchedulerUUID",
        "zoneId" : "zoneUUID",
        "name" : "wlanSchedulerName",
        "description" : "wlanSchedulerDescription",
        "sun" : [ "00:15-01:15", "07:00-08:30", "10:45-12:00" ],
        "mon" : [ "00:15-01:15" ],
        "tue" : [ "00:15-01:15" ],
        "wed" : [ "00:15-01:15" ],
        "thu" : [ "00:15-01:15" ],
        "fri" : [ "00:15-01:15" ],
        "sat" : [ "00:15-01:15" ]
    }
    
    
    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",
                "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 

/v1_0/rkszones/{zoneId}/wlanSchedulers

Use this API command to create a new WLAN schedule.

  • Request
  • Body
    {
        "name" : "wlanSchedulerName",
        "description" : "wlanSchedulerDescription",
        "sun" : [ "00:15-01:15", "07:00-08:30", "10:45-12:00" ],
        "mon" : [ "00:15-01:15" ],
        "tue" : [ "00:15-01:15" ],
        "wed" : [ "00:15-01:15" ],
        "thu" : [ "00:15-01:15" ],
        "fri" : [ "00:15-01:15" ],
        "sat" : [ "00:15-01:15" ]
    }
    
    
    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",
                "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"
                }
            }
        },
        "required" : [ "name" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanSchedulerUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the WLAN schedule",
                "type" : "string"
            }
        }
    }
    
    

Modify 

/v1_0/rkszones/{zoneId}/wlanSchedulers/{id}

Use this API command to modify a WLAN schedule.

  • Request
  • 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",
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN schedule"
        }
    }
    
    
  • Response  204

Delete 

/v1_0/rkszones/{zoneId}/wlanSchedulers/{id}

Use this API command to delete a WLAN schedule.

  • Response  204

AP APP 

Retrieve Total AP Count 

/v1_0/aps/totalCount

Use this API command to retrieve the total AP count within a zone or a domain.

  • Parameters
  • 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
  • Body
    The total count (integer)
    
    

Retrieve AP Summary 

/v1_0/aps/lineman

Use this API command to retrieve the summary information of an AP. This is used by the Ruckus Wireless AP mobile app.

  • Parameters
  • index
    number (optional) 

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

    listSize
    number (optional) 

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

    zoneId
    string (optional) 

    filter AP lineman by zone. Default: current login domain

    domainId
    string (optional) 

    filter AP lineman by domain. Default: current login domain

    showAlarm
    string (optional) 

    indicate to show alarm counter. Default: true

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "mac" : "00:11:22:33:44:55",
            "name" : "apName",
            "latitude" : "22.3",
            "longitude" : "114",
            "location" : "location",
            "configState" : "newConfig",
            "alarms" : {
                "criticalCount" : 0,
                "majorCount" : 1,
                "minorCount" : 7,
                "warningCount" : 0
            }
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "description" : "Total AP count",
                "type" : "integer"
            },
            "hasMore" : {
                "description" : "Indicates if there are more APs after the currently displayed list",
                "type" : "boolean"
            },
            "firstIndex" : {
                "description" : "Index of the first AP returned out of the complete AP list",
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "mac" : {
                            "type" : "string",
                            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
                            "description" : "MAC address of the AP"
                        },
                        "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 

/v1_0/lineman/workflow

Use this API command to upload a workflow file used by the Ruckus Wireless AP mobile app.

  • Request
  • Body
    The workflow file
    
    
  • Response  204

Download Workflow File 

/v1_0/lineman/workflow

Use this API command to download the workflow file used by the Ruckus Wireless AP mobile app.

  • Response  200
  • Body
    The workflow file
    
    

Connectivity Tools 

SpeedFlex 

/v1_0/tool/speedflex

Use this API command to start the SpeedFlex test.

  • Request
  • 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",
                "pattern" : "^(((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))$",
                "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])$",
                "description" : "The HTTP request remove MAC address is used if none is specified"
            },
            "serverIp" : {
                "type" : "string",
                "pattern" : "^(((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))$",
                "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])$",
                "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
  • 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 

/v1_0/tool/speedflex/{wcid}

Use this API command to retrieve existing SpeedFlex test results.

  • Response  200
  • Body
    {
        "wcid" : "123",
        "resultId" : 11,
        "uplink" : 33,
        "downlink" : 44,
        "latency" : 23,
        "packetLoss" : 21,
        "etf" : 21
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "wcid" : {
                "descriptin" : "WCID",
                "type" : "string"
            },
            "resultId" : {
                "description" : "Result ID",
                "type" : "integer"
            },
            "uplink" : {
                "description" : "Uplink",
                "type" : "integer"
            },
            "downlink" : {
                "description" : "Downlink",
                "type" : "integer"
            },
            "latency" : {
                "description" : "Latency",
                "type" : "integer"
            },
            "packetLoss" : {
                "description" : "Packet loss",
                "type" : "integer"
            },
            "etf" : {
                "description" : "ETF",
                "type" : "integer"
            }
        }
    }
    
    

Ping 

/v1_0/tool/ping

Use this API command to run the PING test on an AP.

  • Parameters
  • apMac
    string (required) 

    MAC address of the AP running the PING test

    targetIP
    string (required) 

    the IP address to PING

Trace Route 

/v1_0/tool/traceRoute

Use this API command to run the traceroute test on an AP.

  • Parameters
  • 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
  • Body
    Trace Route Result
    
    

System 

System Summary 

/v1_0/controller

Use this API command to retrieve the system summary.

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "b42be2c8-71bf-465a-8fd2-3911dcf885e4",
            "model" : "SCG200",
            "description" : "gui96-scg200-vm",
            "hostName" : "gui96-scg200-vm",
            "mac" : "00:0C:29:B1:34:69",
            "serialNumber" : "00000096",
            "clusterRole" : "Follower",
            "controlNatIp" : null,
            "uptimeInSec" : 165561,
            "name" : "gui96-scg200-vm-C",
            "version" : "3.0.0.0.211",
            "cpVersion" : "3.0.0.0.543",
            "dpVersion" : "3.0.0.0.56",
            "apVersion" : "3.0.0.0.125",
            "controlIp" : "172.18.114.29",
            "dataIp" : 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 controller",
                            "type" : "string"
                        },
                        "model" : {
                            "description" : "Product model",
                            "type" : "string"
                        },
                        "description" : {
                            "description" : "Description of the controller",
                            "type" : "string"
                        },
                        "hostName" : {
                            "description" : "Host name of the controller",
                            "type" : "string"
                        },
                        "mac" : {
                            "description" : "MAC address of the controller",
                            "type" : "string"
                        },
                        "serialNumber" : {
                            "description" : "Serial number of the controller",
                            "type" : "string"
                        },
                        "clusterRole" : {
                            "description" : "Indicator the role of the controller",
                            "type" : "string"
                        },
                        "controlNatIp" : {
                            "description" : "Control NAT IP address settings",
                            "type" : "string"
                        },
                        "uptimeInSec" : {
                            "description" : "Uptime (in seconds) of the controller",
                            "type" : "integer"
                        },
                        "name" : {
                            "description" : "Name of the controller",
                            "type" : "string"
                        },
                        "version" : {
                            "description" : "SCG version",
                            "type" : "string"
                        },
                        "cpVersion" : {
                            "description" : "Control plane version",
                            "type" : "string"
                        },
                        "dpVersion" : {
                            "description" : "Data plane version",
                            "type" : "string"
                        },
                        "apVersion" : {
                            "description" : "AP version",
                            "type" : "string"
                        },
                        "controlIp" : {
                            "description" : "Control IP",
                            "type" : "string"
                        },
                        "dataIp" : {
                            "description" : "Data IP",
                            "type" : "string"
                        }
                    }
                }
            }
        }
    }
    
    

AP Models 

/v1_0/system/apmodels

Use this API command to retrieve AP models.

  • Response  200
  • Body
    List of AP Models(ex: ["ZF7782","ZF7762"])
    
    

Wireless Client 

Retrieve Total Client Count 

/v1_0/aps/{apMac}/operational/client/totalCount

Use this API command to retrieve the total client count per AP.

  • Response  200
  • Body
    The total count (integer)
    
    

Retrieve Client List 

/v1_0/aps/{apMac}/operational/client

Use this API command to retrieve the client list per AP.

  • Parameters
  • index
    number (optional) 

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

    listSize
    number (optional) 

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

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "mac" : "3C:A9:F4:0C:85:B0",
            "ipAddress" : "172.18.116.141",
            "hostName" : "SDC-Randall-PC",
            "osType" : "Windows 7/Vista",
            "user" : "",
            "status" : "AUTHORIZED",
            "radioId" : "0",
            "radioMode" : null,
            "channel" : "11",
            "wlanId" : "1",
            "ssid" : "client-test",
            "fromClientBytes" : 240863,
            "toClientBytes" : 642897,
            "fromClientPkts" : 2247,
            "toClientPkts" : 7678,
            "connectedSince" : 2600
        } ]
    }
    
    
    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])$",
                            "description" : "MAC address of the Client"
                        },
                        "ipAddress" : {
                            "type" : "string",
                            "pattern" : "^(((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))[.](((2[0-4]\d)|(25[0-5]))|(1\d{2})|([1-9]\d)|(\d))$",
                            "description" : "IP 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 identifier",
                            "type" : "string"
                        },
                        "radioMode" : {
                            "description" : "Radio mode",
                            "type" : "string"
                        },
                        "channel" : {
                            "description" : "Channel",
                            "type" : "string"
                        },
                        "wlanId" : {
                            "description" : "WLAN identifier",
                            "type" : "string"
                        },
                        "ssid" : {
                            "description" : "SSID",
                            "type" : "string"
                        },
                        "rssi" : {
                            "description" : "RSSI",
                            "type" : "string"
                        },
                        "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"
                        }
                    }
                }
            }
        }
    }
    
    

Generated by aglio on 16 Jan 2015