Back to top

Overview

This reference guide describes the public APIs supported by the Virtual SmartZone (High Scale). 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).

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

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

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

HTTP Responses

Successful Requests

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

Failed Requests

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

Errors

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

Ruckus Wireless Error Codes

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

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

Change Logs

  • What’s New

    • Ruckus Wireless AP Zone
      • Retrieve
      • Create Zone of IPV6
      • Modify Radio 2.4G/5G
      • Modify/Disable Syslog
      • Modify/Disable Smart Monitor
      • Modify/Disable Client Admission Control 2.4G/5G
      • Modify Tunnel Profile
      • Modify/Disable Background Scanning 2.4G/5G
      • Modify/Disable Client Load Balancing 2.4G/5G
      • Modify/Disable Band Balancing
      • Modify AP Reboot Timeout
      • Modify Node Affinity Profile
      • Modify/Clear Hotspot2.0 Venue Profile
      • Modify/Disable Rogue
      • Modify/Disable Location Based Service
      • Retrieve/Modify AP Model
    • AP Group
      • Disable Location Override
      • Disable Location AdditonalInfo Override
      • Modify/Disable Radio 2.4G/5G Override
      • Modify/Disable WLAN group 2.4G/5G
      • Modify/Disable Location Based Service Override
      • Modify/Disable Client Admission Control 2.4G/5G
      • Modify/Clear Hotspot2.0 Venue Profile
      • Retrieve/Modify/Disable AP Model
    • Access Point Configuration
      • Disable Location Override
      • Disable Location AdditonalInfo Override
      • Modify/Disable Smart Monitor
      • Modify/Disable Bonjour Gateway
      • Modify/Disable Client Admission Control 2.4G/5G
      • Modify/Clear Hotspot2.0 Venue Profile
      • Modify User Location Info
      • Modify/Disable Model Specific
    • Access Point Operational
      • Retrieve Mesh Neighbor AP List
      • Retrieve Rogue AP List
    • WLAN Group
      • Modify Member VLAN Pooling
      • Disable Member VLAN Override
      • Disable Member NAS Override
    • WLAN
      • Create - Hotstpot2.0
      • Create Hotspot2.0 OSEN
      • Modify/Disable DiffServ Profile
      • Enable/Modify/Disable Qos Map Set
      • Modify Online Sign Service
      • Disable Zero-IT Onboarding(belong to Online Signup Service)
    • AAA
    • Zone - Web Authentication
    • Zone - Guest Access
    • Zone - Hotspot Service
    • Zone - Hotspot2.0 WLAN Profile
    • Authentication Service
    • Accounting Service
    • Profile(including Authentication & Accounting)
    • Hotspot Profile
    • Online Singup Profile
    • Hotspot2.0 Venue Profile
    • Hotspot2.0 Wi-Fi Operator Profile
    • Hotspot2.0 Identity Provider Profile
    • Certificate
    • System
      • System Statistics
      • System Inventory
  • Changes

    • Ruckus Wireless AP Zone
      • Modify Basic
        • attributes added “channelModeEnabled”, “tunnelType”, “location”, “locationAdditionalInfo”, “latitude”, “longitude”, “vlanOverlappingEnabled”
    • AP Group
      • Retrieve
        • attributes added “location”, “locationAdditionalInfo”, “latitude”, “longitude”, “wifi24”, “wifi50”, “wlanGroup24”, “wlanGroup50”, “locationBasedService”, “clientAdmissionControl24”, “clientAdmissionControl50”, “venueProfile”
      • Modify Basic
        • attributes added “location”, “locationAdditionalInfo”, “latitude”, “longitude”
    • Access Point Configuration
      • Retrieve
        • attributes added “locationAdditionalInfo”, “userLocationInfo”, “wlanService24Enabled”, “wlanService50Enabled”, “smartMonitor”, “bonjouarGateway”, “clientAdmissionControl24”, “clientAdmissionControl50”, “venueProfile”, “specific”
      • Modify Basic
        • attributes added “locationAdditionalInfo”, “wlanService24Enabled”, “wlanService50Enabled”
      • Modify Radio 2.4G Override
        • attribute “channelWidth” remove 0 & 40
    • WLAN Group
      • Add Member
        • attributes added “vlanPooling”, “nasId”, remove 0 mean not overrided of attribute “accessVlan”
    • WLAN
      • Retrieve
        • attributes added “hessid”, “diffServProfile”, “qosMaps”, “onlineSignupService”, “bypassCNA”
        • attribute “type” added “Hotspot20_OSEN”
        • attribute “encryption” added “mfp”
        • attribute “authServiceOrProfile” added “locationDeliveryEnabled”
        • attribute “coreTunnelProfile” added “operatorRealm”
        • attribute “vlan” added “vlanPooling”
        • attribute “advancedOptions” added “pmkCachingEnabled”, “okcEnabled”, removed “uplinkRateLimiting”, “downlinkRateLimiting”
      • Modify Basic
        • attributes added “hessid”, “bypassCNA”
      • Modify Authentication
        • attribute added “locationDeliveryEnabled”
      • Modify Encryption
        • attribute added “mfp”
      • Modify Core Tunnel
        • attribute added “operatorRealm”, also “Bridge” required Forwording Profile
      • Modify VLAN
        • attribute added “vlanPooling”
      • Modify Advanced Options
        • attribute “advancedOptions” added “pmkCachingEnabled”, “okcEnabled”, removed “uplinkRateLimiting”, “downlinkRateLimiting”
  • Backward Compatible Notice

    • WLAN
      • Create - Hotstpot2.0
        • this is totally changed compare with previous version
      • Modify Advanced Options
        • as attributes “uplinkRateLimiting”, “downlinkRateLimiting” removed, so they could not be effected with previous version

Login Session 

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

Logon 

/v2_1/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", "-00:00", "±00:00", "+01:00", "+02:00", "+03:00", "+03:30", "+04:00", "+04:30", "+05:00", "+05:30", "+05:45", "+06:00", "+06:30", "+07:00", "+08:00", "+08:45", "+09:00", "+09:30", "+10:00", "+10:30", "+11:00", "+11:30", "+12:00", "+12:45", "+13:00", "+14:00" ]
            }
        },
        "required" : [ "username", "password" ]
    }
    
    
  • Response  200
  • Body
    {
        "apiVersion" : "1"
    }
    
    
    Schema
    {
        "type" : "object",
        "properties" : {
            "controllerVersion" : {
                "type" : "string"
            }
        }
    }
    
    

Logoff 

/v2_1/session

Use this API command to log off of the controller.

  • Response  200

Retrieve 

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

/v2_1/rkszones

Use this API command to retrieve the list of Ruckus Wireless 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 

/v2_1/rkszones/{id}

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

  • Response  200
  • Body
    {
        "id" : "ad5ffab1-b3ed-4b36-b054-bc723a977dbb",
        "domainId" : "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
        "name" : "public-api-zone-ipv6",
        "description" : null,
        "countryCode" : "US",
        "version" : "3.1.0.0.55",
        "timezone" : {
            "systemTimezone" : "UTC",
            "customizedTimezone" : null
        },
        "ipMode" : "IPV6",
        "login" : {
            "apLoginName" : "admin",
            "apLoginPassword" : "admin!234"
        },
        "mesh" : null,
        "wifi24" : {
            "txPower" : "Full",
            "channelWidth" : 20,
            "channel" : 0
        },
        "wifi50" : {
            "txPower" : "Full",
            "channelWidth" : 40,
            "indoorChannel" : 0,
            "outdoorChannel" : 0
        },
        "syslog" : null,
        "smartMonitor" : null,
        "clientAdmissionControl24" : null,
        "clientAdmissionControl50" : null,
        "channelModeEnabled" : false,
        "tunnelType" : "No_Tunneled",
        "tunnelProfile" : null,
        "backgroundScanning24" : null,
        "backgroundScanning50" : null,
        "clientLoadBalancing24" : null,
        "clientLoadBalancing50" : null,
        "bandBalancing" : null,
        "rogue" : null,
        "locationBasedService" : null,
        "apRebootTimeout" : {
            "gatewayLossTimeoutInSec" : 1800,
            "serverLossTimeoutInSec" : 7200
        },
        "location" : null,
        "locationAdditionalInfo" : null,
        "latitude" : null,
        "longitude" : null,
        "vlanOverlappingEnabled" : false,
        "nodeAffinityProfile" : null,
        "venueProfile" : null,
        "autoChannelSelection24" : {
            "channelSelectMode" : "ChannelFly"
        },
        "autoChannelSelection50" : {
            "channelSelectMode" : "BackgroundScanning"
        },
        "channelEvaluationInterval" : 777,
        "ipsecProfile" : {
            "id" : "ipsecProfileId",
            "name" : "ipsecProfileName"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the zone",
                "type" : "string"
            },
            "domainId" : {
                "description" : "Identifier of the management domain to which the zone belongs",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the zone"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the zone"
            },
            "version" : {
                "type" : "string",
                "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
                "description" : "AP firmware version of the zone"
            },
            "countryCode" : {
                "description" : "Country code of the zone",
                "type" : "string"
            },
            "timezone" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "systemTimezone" : {
                        "description" : "System defined time zone",
                        "type" : "string"
                    },
                    "customizedTimezone" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "abbreviation" : {
                                "description" : "Time zone abbreviation",
                                "type" : "string",
                                "pattern" : "^[a-zA-Z]{3,4}$"
                            },
                            "gmtOffset" : {
                                "description" : "GMT offset ",
                                "type" : "integer",
                                "minimum" : -11,
                                "maximum" : 14
                            },
                            "gmtOffsetMinute" : {
                                "description" : "GMT offset minute",
                                "type" : "integer",
                                "minimum" : 0,
                                "maximum" : 59
                            },
                            "start" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "properties" : {
                                    "month" : {
                                        "description" : "Month when daylight saving time begins",
                                        "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                    },
                                    "week" : {
                                        "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                        "enum" : [ 1, 2, 3, 4, 5 ]
                                    },
                                    "day" : {
                                        "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                        "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                    },
                                    "hour" : {
                                        "description" : "Hour of the day",
                                        "type" : "integer",
                                        "minimum" : 0,
                                        "maximum" : 23
                                    }
                                },
                                "required" : [ "month", "week", "day", "hour" ],
                                "description" : "Daylight saving time start"
                            },
                            "end" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "properties" : {
                                    "month" : {
                                        "description" : "Month when daylight saving time begins",
                                        "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                    },
                                    "week" : {
                                        "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                        "enum" : [ 1, 2, 3, 4, 5 ]
                                    },
                                    "day" : {
                                        "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                        "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                    },
                                    "hour" : {
                                        "description" : "Hour of the day",
                                        "type" : "integer",
                                        "minimum" : 0,
                                        "maximum" : 23
                                    }
                                },
                                "required" : [ "month", "week", "day", "hour" ],
                                "description" : "Daylight saving time end"
                            }
                        },
                        "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ],
                        "description" : "User defined time zone"
                    }
                }
            },
            "login" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "apLoginName" : {
                        "type" : "string",
                        "maxLength" : 64,
                        "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
                        "description" : "User name of the AP administrator"
                    },
                    "apLoginPassword" : {
                        "type" : "string",
                        "maxLength" : 64,
                        "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
                        "description" : "Password of the AP administrator"
                    }
                },
                "required" : [ "apLoginName", "apLoginPassword" ],
                "description" : "AP administrator account"
            },
            "ipMode" : {
                "enum" : [ "IPV4", "IPV6" ],
                "description" : "IP mode of the zone"
            },
            "mesh" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "ssid" : {
                        "description" : "SSID of the mesh network",
                        "type" : "string"
                    },
                    "passphrase" : {
                        "description" : "Passphrase for the mesh network",
                        "type" : "string"
                    }
                },
                "description" : "Mesh configuration of the zone."
            },
            "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 (only 20 is currently supported)",
                        "enum" : [ 20 ]
                    },
                    "channel" : {
                        "description" : "Channel number",
                        "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
                    }
                },
                "description" : "AP 2.4GHz radio configuration of the zone."
            },
            "wifi50" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "txPower" : {
                        "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                        "description" : "Transmission power"
                    },
                    "channelWidth" : {
                        "description" : "Channel width. Zero (0) means Auto.",
                        "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" : "AP 5GHz radio configuration of the zone."
            },
            "syslog" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "address" : {
                        "type" : "string",
                        "description" : "Address of the syslog server."
                    },
                    "port" : {
                        "description" : "Port number of the syslog server",
                        "type" : "integer",
                        "default" : 514,
                        "minimum" : 1,
                        "maximum" : 65535
                    },
                    "facility" : {
                        "description" : "Facility of the syslog server",
                        "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                        "default" : "keep_Original"
                    },
                    "priority" : {
                        "description" : "Priority of the log messages",
                        "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                        "default" : "Error"
                    }
                },
                "description" : "Syslog configuration of the zone."
            },
            "smartMonitor" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "intervalInSec" : {
                        "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                        "type" : "integer",
                        "default" : 10,
                        "minimum" : 5,
                        "maximum" : 60
                    },
                    "retryThreshold" : {
                        "description" : "Retry threshold. This is required if smartMonitor is enabled",
                        "type" : "integer",
                        "default" : 3,
                        "minimum" : 1,
                        "maximum" : 10
                    }
                },
                "description" : "Smart monitor configuration of the zone."
            },
            "clientAdmissionControl24" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "maxRadioLoadPercent" : {
                        "description" : "Maximum radio load percentage.",
                        "type" : "integer",
                        "default" : 75,
                        "minimum" : 50,
                        "maximum" : 100
                    },
                    "minClientCount" : {
                        "description" : "Minimum client count number.",
                        "type" : "integer",
                        "default" : 10,
                        "minimum" : 0,
                        "maximum" : 100
                    },
                    "minClientThroughputMbps" : {
                        "description" : "Minimum client throughput in Mbps.",
                        "type" : "number",
                        "default" : 0,
                        "minimum" : 0,
                        "maximum" : 100
                    }
                },
                "description" : "AP client admission control 2.4GHz radio configuration of the zone."
            },
            "clientAdmissionControl50" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "maxRadioLoadPercent" : {
                        "description" : "Maximum radio load percentage.",
                        "type" : "integer",
                        "default" : 75,
                        "minimum" : 50,
                        "maximum" : 100
                    },
                    "minClientCount" : {
                        "description" : "Minimum client count number.",
                        "type" : "integer",
                        "default" : 10,
                        "minimum" : 0,
                        "maximum" : 100
                    },
                    "minClientThroughputMbps" : {
                        "description" : "Minimum client throughput in Mbps.",
                        "type" : "number",
                        "default" : 0,
                        "minimum" : 0,
                        "maximum" : 100
                    }
                },
                "description" : "AP client admission control 5GHz radio configuration of the zone."
            },
            "channelModeEnabled" : {
                "description" : "Channel mode configuration of the zone.",
                "type" : "boolean"
            },
            "tunnelType" : {
                "description" : "tunnel type configuration of the Zone. No_Tunneled -- for ipv6",
                "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
            },
            "tunnelProfile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Tunnel type configuration of the zone."
            },
            "backgroundScanning24" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "frequencyInSec" : {
                        "description" : "Frequency in second",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 65535
                    }
                },
                "description" : "Background scanning on 2.4GHz radio configuration of the zone."
            },
            "backgroundScanning50" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "frequencyInSec" : {
                        "description" : "Frequency in second",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 65535
                    }
                },
                "description" : "Background scanning on 5GHz radio configuration of the zone."
            },
            "clientLoadBalancing24" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "adjacentRadioThreshold" : {
                        "description" : "Adjacent radio threshold",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 100
                    }
                },
                "description" : "Client load balancing on 2.4GHz radio configuration of the zone."
            },
            "clientLoadBalancing50" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "adjacentRadioThreshold" : {
                        "description" : "Adjacent radio threshold",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 100
                    }
                },
                "description" : "Client load balancing on 5GHz radio configuration of the zone."
            },
            "bandBalancing" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "wifi24Percentage" : {
                        "description" : "Percentage of client load on 2.4GHz radio band",
                        "type" : "integer",
                        "minimum" : 0,
                        "maximum" : 100
                    }
                },
                "description" : "Band balancing configuration of the zone."
            },
            "rogue" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "reportType" : {
                        "description" : "Report type",
                        "enum" : [ "All", "Malicious" ]
                    },
                    "maliciousTypes" : {
                        "description" : "Malicious type when reportType is Malicious",
                        "type" : [ "array", "null" ],
                        "items" : {
                            "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                        }
                    },
                    "protectionEnabled" : {
                        "description" : "Protection enabled",
                        "type" : "boolean"
                    }
                },
                "description" : "Rogue AP detection configuration of the zone."
            },
            "locationBasedService" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Location based service configuration of the zone."
            },
            "apRebootTimeout" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "gatewayLossTimeoutInSec" : {
                        "description" : "Gateway loss timeout in second",
                        "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
                    },
                    "serverLossTimeoutInSec" : {
                        "description" : "Server loss timeout in second",
                        "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                    }
                },
                "description" : "AP reboot timeout of the zone."
            },
            "location" : {
                "type" : "string",
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Location of the Zone."
            },
            "locationAdditionalInfo" : {
                "type" : "string",
                "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                "description" : "Location additional info of the zone."
            },
            "latitude" : {
                "type" : "number",
                "description" : "Latitude coordinate (in decimal format) of the zone"
            },
            "longitude" : {
                "type" : "number",
                "description" : "Longitude coordinate (in decimal format) of the zone"
            },
            "vlanOverlappingEnabled" : {
                "description" : "VLAN pooling overlapping of the zone",
                "type" : "boolean"
            },
            "nodeAffinityProfile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Node affinity profile of the zone."
            },
            "venueProfile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "venue profile configuration of the Zone."
            },
            "autoChannelSelection24" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "channelSelectMode" : {
                        "description" : "Channel Select Mode",
                        "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                    }
                },
                "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
            },
            "autoChannelSelection50" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "channelSelectMode" : {
                        "description" : "Channel Select Mode",
                        "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                    }
                },
                "description" : "client load balancing on Radio 5G, auto channel selection mode"
            },
            "channelEvaluationInterval" : {
                "description" : "channel evaluation Interval of the zone",
                "type" : "integer",
                "default" : 600,
                "minimum" : 60,
                "maximum" : 3600
            },
            "ipsecProfile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "ipsec profile configuration of the Zone."
            }
        }
    }
    
    

Retrieve Mesh Configuration 

/v2_1/rkszones/{id}/mesh

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

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

Modify Mesh Configuration 

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

Create Zone 

/v2_1/rkszones

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

  • Request
  • Body
    {
        "domainId" : "domainUUID",
        "name" : "zoneName",
        "login" : {
            "apLoginName" : "apLoginName",
            "apLoginPassword" : "apLoginPassword"
        },
        "description" : "description",
        "version" : "3.0.0.0.145",
        "countryCode" : "US"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "domainId" : {
                "description" : "Identifier of the management domain to which the zone belongs",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the zone"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the zone"
            },
            "version" : {
                "type" : "string",
                "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
                "description" : "AP firmware version of the zone"
            },
            "countryCode" : {
                "description" : "Country code of the zone",
                "type" : "string"
            },
            "login" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "apLoginName" : {
                        "type" : "string",
                        "maxLength" : 64,
                        "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
                        "description" : "User name of the AP administrator"
                    },
                    "apLoginPassword" : {
                        "type" : "string",
                        "maxLength" : 64,
                        "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
                        "description" : "Password of the AP administrator"
                    }
                },
                "required" : [ "apLoginName", "apLoginPassword" ],
                "description" : "AP administrator account"
            }
        },
        "required" : [ "name", "login" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "zoneUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the zone",
                "type" : "string"
            }
        }
    }
    
    

Create Zone of IPv6 

/v2_1/rkszones/ipv6

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

  • Request
  • Body
    {
        "domainId" : "domainUUID",
        "name" : "zoneName",
        "login" : {
            "apLoginName" : "apLoginName",
            "apLoginPassword" : "apLoginPassword"
        },
        "description" : "description",
        "version" : "3.0.0.0.145",
        "countryCode" : "US"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "domainId" : {
                "description" : "Identifier of the management domain to which the zone belongs",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the zone"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the zone"
            },
            "version" : {
                "type" : "string",
                "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
                "description" : "AP firmware version of the zone"
            },
            "countryCode" : {
                "description" : "Country code of the zone",
                "type" : "string"
            },
            "login" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "apLoginName" : {
                        "type" : "string",
                        "maxLength" : 64,
                        "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
                        "description" : "User name of the AP administrator"
                    },
                    "apLoginPassword" : {
                        "type" : "string",
                        "maxLength" : 64,
                        "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
                        "description" : "Password of the AP administrator"
                    }
                },
                "required" : [ "apLoginName", "apLoginPassword" ],
                "description" : "AP administrator account"
            }
        },
        "required" : [ "name", "login" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "zoneUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the zone",
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v2_1/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",
        "channelModeEnabled" : false,
        "tunnelType" : "RuckusGRE",
        "location" : "location",
        "locationAdditionalInfo" : "locationAdditionalInfo",
        "latitude" : 23,
        "longitude" : 23,
        "vlanOverlappingEnabled" : false,
        "channelEvaluationInterval" : 777
    }
    
    
    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", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the zone"
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
            "description" : "AP firmware version of the zone"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "channelModeEnabled" : {
            "description" : "Channel mode configuration of the zone.",
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "tunnel type configuration of the Zone. No_Tunneled -- for ipv6",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the zone."
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Location additional info of the zone."
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the zone"
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the zone"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        }
    }
    
    
  • Response  204

Modify Time Zone 

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

Modify AP Logon 

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

Modify Radio 2.4G 

/v2_1/rkszones/{id}/wifi24

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

  • 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 (only 20 is currently supported)",
                "enum" : [ 20 ]
            },
            "channel" : {
                "description" : "Channel number",
                "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
            }
        },
        "description" : "AP 2.4GHz radio configuration of the zone."
    }
    
    
  • Response  204

Modify Radio 5G 

/v2_1/rkszones/{id}/wifi50

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

  • 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" : "AP 5GHz radio configuration of the zone."
    }
    
    
  • Response  204

Modify Syslog 

/v2_1/rkszones/{id}/syslog

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

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

Disable Syslog 

/v2_1/rkszones/{id}/syslog

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

  • Response  204

Modify Smart Monitor 

/v2_1/rkszones/{id}/smartMonitor

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

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

Disable Smart Monitor 

/v2_1/rkszones/{id}/smartMonitor

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

  • Response  204

Modify Client Admission Control 2.4G 

/v2_1/rkszones/{id}/clientAdmissionControl24

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

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

Disable Client Admission Control 2.4G 

/v2_1/rkszones/{id}/clientAdmissionControl24

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

  • Response  204

Modify Client Admission Control 5G 

/v2_1/rkszones/{id}/clientAdmissionControl50

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

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

Disable Client Admission Control 5G 

/v2_1/rkszones/{id}/clientAdmissionControl50

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

  • Response  204

Modify Tunnel Profile 

/v2_1/rkszones/{id}/tunnelProfile

Use this API command to modify the tunnel profile for APs that belong to a zone.

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

Modify Background Scanning 2.4G 

/v2_1/rkszones/{id}/backgroundScanning24

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

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

Disable Background Scanning 2.4G 

/v2_1/rkszones/{id}/backgroundScanning24

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

  • Response  204

Modify Background Scanning 5G 

/v2_1/rkszones/{id}/backgroundScanning50

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

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

Disable Background Scanning 5G 

/v2_1/rkszones/{id}/backgroundScanning50

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

  • Response  204

Modify Client Load Balancing 2.4G 

/v2_1/rkszones/{id}/clientLoadBalancing24

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

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

Disable Client Load Balancing 2.4G 

/v2_1/rkszones/{id}/clientLoadBalancing24

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

  • Response  204

Modify Client Load Balancing 5G 

/v2_1/rkszones/{id}/clientLoadBalancing50

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

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

Disable Client Load Balancing 5G 

/v2_1/rkszones/{id}/clientLoadBalancing50

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

  • Response  204

Modify Band Balancing 

/v2_1/rkszones/{id}/bandBalancing

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

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

Disable Band Balancing 

/v2_1/rkszones/{id}/bandBalancing

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

  • Response  204

Modify AP Reboot Timeout 

/v2_1/rkszones/{id}/apRebootTimeout

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

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

Modify Node Affinity Profile 

/v2_1/rkszones/{id}/nodeAffinityProfile

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

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

Modify Hotspot2.0 Venue Profile 

/v2_1/rkszones/{id}/venueProfile

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

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

Clear Hotspot2.0 Venue Profile 

/v2_1/rkszones/{id}/venueProfile

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

  • Response  204

Modify Rogue 

/v2_1/rkszones/{id}/rogue

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

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

Disable Rogue 

/v2_1/rkszones/{id}/rogue

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

  • Response  204

Modify Location Based Service 

/v2_1/rkszones/{id}/locationBasedService

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

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

Disable Location Based Service 

/v2_1/rkszones/{id}/locationBasedService

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

  • Response  204

Retrieve AP Model 

/v2_1/rkszones/{zoneId}/apmodel/{model}

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

  • Response  200
  • Body
    {
        "ledStatusEnabled" : false,
        "lldp" : {
            "enabled" : true,
            "advertiseIntervalInSec" : 100,
            "holdTimeInSec" : 1000,
            "managementIPTLVEnabled" : false
        },
        "ledMode" : null,
        "internalHeaterEnabled" : null,
        "poeOutPortEnabled" : null,
        "poeModeSetting" : null,
        "usbPowerEnable" : null,
        "radioBand" : null,
        "externalAntenna24" : null,
        "externalAntenna50" : null,
        "lanPorts" : [ {
            "portName" : "LAN1",
            "enabled" : true,
            "type" : "Trunk",
            "vlanUntagId" : 13,
            "members" : "1-4094",
            "_8021X" : {
                "type" : "Disable",
                "authenticator" : null,
                "supplicant" : null
            }
        }, {
            "portName" : "LAN2",
            "enabled" : true,
            "type" : "Access",
            "vlanUntagId" : 15,
            "members" : "15",
            "_8021X" : {
                "type" : "MACBasedAuthenticator",
                "authenticator" : {
                    "authentication" : {
                        "id" : "5f66275c-b1fd-4e25-a4db-b64115740fb9",
                        "name" : "zoneRadius"
                    },
                    "accounting" : {
                        "id" : "b86db5e8-884b-4c90-9315-dcd72acaf743",
                        "name" : "zoneRadiusAcct"
                    },
                    "macAuthByPassEnabled" : true
                },
                "supplicant" : null
            }
        }, {
            "portName" : "LAN3",
            "enabled" : true,
            "type" : "Trunk",
            "vlanUntagId" : 1,
            "members" : "1-4094",
            "_8021X" : {
                "type" : "Supplicant",
                "authenticator" : null,
                "supplicant" : {
                    "type" : "Custom",
                    "userName" : "a",
                    "password" : "a"
                }
            }
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "ledStatusEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "lldp" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "advertiseIntervalInSec" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 1,
                        "maximum" : 300
                    },
                    "holdTimeInSec" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 60,
                        "maximum" : 1200
                    },
                    "managementIPTLVEnabled" : {
                        "type" : [ "boolean", "null" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "ledMode" : {
                "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
            },
            "internalHeaterEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "poeOutPortEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "poeModeSetting" : {
                "enum" : [ null, "Auto", "_802_3af" ]
            },
            "usbPowerEnable" : {
                "type" : [ "boolean", "null" ]
            },
            "radioBand" : {
                "enum" : [ null, "2.4GHz", "5GHz" ]
            },
            "externalAntenna24" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "dbi" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 90
                    },
                    "chainMask" : {
                        "enum" : [ null, "Two", "Three" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "externalAntenna50" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "dbi" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 90
                    },
                    "chainMask" : {
                        "enum" : [ null, "Two", "Three" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "lanPorts" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "portName" : {
                            "enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
                        },
                        "enabled" : {
                            "type" : "boolean"
                        },
                        "type" : {
                            "enum" : [ null, "Access", "Trunk", "General" ]
                        },
                        "vlanUntagId" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 4094
                        },
                        "members" : {
                            "type" : [ "string", "null" ]
                        },
                        "_8021X" : {
                            "type" : [ "object", "null" ],
                            "additionalProperties" : false,
                            "properties" : {
                                "type" : {
                                    "enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
                                },
                                "authenticator" : {
                                    "type" : [ "object", "null" ],
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "authentication" : {
                                            "type" : [ "object", "null" ],
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "id" : {
                                                    "type" : "string"
                                                },
                                                "name" : {
                                                    "type" : "string"
                                                }
                                            }
                                        },
                                        "accounting" : {
                                            "type" : [ "object", "null" ],
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "id" : {
                                                    "type" : "string"
                                                },
                                                "name" : {
                                                    "type" : "string"
                                                }
                                            }
                                        },
                                        "macAuthByPassEnabled" : {
                                            "type" : "boolean"
                                        }
                                    },
                                    "required" : [ "authentication", "macAuthByPassEnabled" ]
                                },
                                "supplicant" : {
                                    "type" : [ "object", "null" ],
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "type" : {
                                            "enum" : [ "MACAddress", "Custom" ]
                                        },
                                        "userName" : {
                                            "type" : [ "string", "null" ],
                                            "maxLength" : 64,
                                            "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
                                        },
                                        "password" : {
                                            "type" : [ "string", "null" ],
                                            "maxLength" : 64,
                                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                                        }
                                    },
                                    "required" : [ "type" ]
                                }
                            },
                            "required" : [ "type" ]
                        }
                    },
                    "required" : [ "portName", "enabled" ]
                }
            }
        }
    }
    
    

Modify AP Model 

/v2_1/rkszones/{zoneId}/apmodel/{model}

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

  • Request
  • Body
    {
        "ledStatusEnabled" : false,
        "lldp" : {
            "enabled" : true,
            "advertiseIntervalInSec" : 100,
            "holdTimeInSec" : 1000,
            "managementIPTLVEnabled" : false
        },
        "ledMode" : null,
        "internalHeaterEnabled" : null,
        "poeOutPortEnabled" : null,
        "poeModeSetting" : null,
        "usbPowerEnable" : null,
        "radioBand" : null,
        "externalAntenna24" : null,
        "externalAntenna50" : null,
        "lanPorts" : [ {
            "portName" : "LAN1",
            "enabled" : true,
            "type" : "Trunk",
            "vlanUntagId" : 13,
            "members" : "1-4094",
            "_8021X" : {
                "type" : "Disable",
                "authenticator" : null,
                "supplicant" : null
            }
        }, {
            "portName" : "LAN2",
            "enabled" : true,
            "type" : "Access",
            "vlanUntagId" : 15,
            "members" : "15",
            "_8021X" : {
                "type" : "MACBasedAuthenticator",
                "authenticator" : {
                    "authentication" : {
                        "id" : "5f66275c-b1fd-4e25-a4db-b64115740fb9",
                        "name" : "zoneRadius"
                    },
                    "accounting" : {
                        "id" : "b86db5e8-884b-4c90-9315-dcd72acaf743",
                        "name" : "zoneRadiusAcct"
                    },
                    "macAuthByPassEnabled" : true
                },
                "supplicant" : null
            }
        }, {
            "portName" : "LAN3",
            "enabled" : true,
            "type" : "Trunk",
            "vlanUntagId" : 1,
            "members" : "1-4094",
            "_8021X" : {
                "type" : "Supplicant",
                "authenticator" : null,
                "supplicant" : {
                    "type" : "Custom",
                    "userName" : "a",
                    "password" : "a"
                }
            }
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "ledStatusEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "lldp" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "advertiseIntervalInSec" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 1,
                        "maximum" : 300
                    },
                    "holdTimeInSec" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 60,
                        "maximum" : 1200
                    },
                    "managementIPTLVEnabled" : {
                        "type" : [ "boolean", "null" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "ledMode" : {
                "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
            },
            "internalHeaterEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "poeOutPortEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "poeModeSetting" : {
                "enum" : [ null, "Auto", "_802_3af" ]
            },
            "usbPowerEnable" : {
                "type" : [ "boolean", "null" ]
            },
            "radioBand" : {
                "enum" : [ null, "2.4GHz", "5GHz" ]
            },
            "externalAntenna24" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "dbi" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 90
                    },
                    "chainMask" : {
                        "enum" : [ null, "Two", "Three" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "externalAntenna50" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "dbi" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 90
                    },
                    "chainMask" : {
                        "enum" : [ null, "Two", "Three" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "lanPorts" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "portName" : {
                            "enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
                        },
                        "enabled" : {
                            "type" : "boolean"
                        },
                        "type" : {
                            "enum" : [ null, "Access", "Trunk", "General" ]
                        },
                        "vlanUntagId" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 4094
                        },
                        "members" : {
                            "type" : [ "string", "null" ]
                        },
                        "_8021X" : {
                            "type" : [ "object", "null" ],
                            "additionalProperties" : false,
                            "properties" : {
                                "type" : {
                                    "enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
                                },
                                "authenticator" : {
                                    "type" : [ "object", "null" ],
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "authentication" : {
                                            "type" : [ "object", "null" ],
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "id" : {
                                                    "type" : "string"
                                                },
                                                "name" : {
                                                    "type" : "string"
                                                }
                                            }
                                        },
                                        "accounting" : {
                                            "type" : [ "object", "null" ],
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "id" : {
                                                    "type" : "string"
                                                },
                                                "name" : {
                                                    "type" : "string"
                                                }
                                            }
                                        },
                                        "macAuthByPassEnabled" : {
                                            "type" : "boolean"
                                        }
                                    },
                                    "required" : [ "authentication", "macAuthByPassEnabled" ]
                                },
                                "supplicant" : {
                                    "type" : [ "object", "null" ],
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "type" : {
                                            "enum" : [ "MACAddress", "Custom" ]
                                        },
                                        "userName" : {
                                            "type" : [ "string", "null" ],
                                            "maxLength" : 64,
                                            "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
                                        },
                                        "password" : {
                                            "type" : [ "string", "null" ],
                                            "maxLength" : 64,
                                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                                        }
                                    },
                                    "required" : [ "type" ]
                                }
                            },
                            "required" : [ "type" ]
                        }
                    },
                    "required" : [ "portName", "enabled" ]
                }
            }
        }
    }
    
    
  • Response  204

Modify Radio 2.4G Auto ChannelSelectMode 

/v2_1/rkszones/{id}/autoChannelSelection24

Modify Radio 2.4G Auto ChannelSelectMode of a zone

  • Request
  • Body
    {
        "channelSelectMode" : "ChannelFly"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "channelSelectMode" : {
                "description" : "Channel Select Mode",
                "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
            }
        },
        "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
    }
    
    
  • Response  204

Modify Radio 5G Auto ChannelSelectMode 

/v2_1/rkszones/{id}/autoChannelSelection50

Modify Radio 5G Auto ChannelSelectMode of a zone

  • Request
  • Body
    {
        "channelSelectMode" : "BackgroundScanning"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "channelSelectMode" : {
                "description" : "Channel Select Mode",
                "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
            }
        },
        "description" : "client load balancing on Radio 5G, auto channel selection mode"
    }
    
    
  • Response  204

Modify IPsec Profile 

/v2_1/rkszones/{id}/ipsecProfile

Modify IPsec Profile of a zone

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

Delete 

/v2_1/rkszones/{id}

Use this API command to delete a zone.

  • Response  204

AP Group 

Retrieve List 

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

/v2_1/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",
        "location" : "test-ap1_modify",
        "locationAdditionalInfo" : "add",
        "latitude" : 34,
        "longitude" : 45,
        "wifi24" : {
            "txPower" : "Full",
            "channelWidth" : 0,
            "channel" : 11
        },
        "wifi50" : null,
        "wlanGroup24" : {
            "id" : "19b10850-7eaa-11e4-a584-08002716c79f",
            "name" : "default"
        },
        "wlanGroup50" : null,
        "locationBasedService" : null,
        "clientAdmissionControl24" : {
            "maxRadioLoadPercent" : 70,
            "minClientCount" : 30,
            "minClientThroughputMbps" : 10.0,
            "enabled" : true
        },
        "clientAdmissionControl50" : null,
        "venueProfile" : null,
        "members" : [ {
            "apMac" : "00:11:22:33:44:55"
        }, {
            "apMac" : "11:22:33:44:55:66"
        } ],
        "autoChannelSelection24" : {
            "channelSelectMode" : "ChannelFly"
        },
        "autoChannelSelection50" : {
            "channelSelectMode" : "BackgroundScanning"
        },
        "channelEvaluationInterval" : 777
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the AP group",
                "type" : "string"
            },
            "zoneId" : {
                "description" : "Identifier of the zone to which the AP group belongs",
                "type" : "string"
            },
            "name" : {
                "description" : "Name of the AP group",
                "type" : "string"
            },
            "description" : {
                "description" : "Description of the AP group",
                "type" : "string"
            },
            "location" : {
                "type" : "string",
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Location of the AP group."
            },
            "locationAdditionalInfo" : {
                "type" : "string",
                "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                "description" : "Location additional info of the AP group."
            },
            "latitude" : {
                "type" : "number",
                "description" : "Latitude coordinate (in decimal format) of the AP group"
            },
            "longitude" : {
                "type" : "number",
                "description" : "Longitude coordinate (in decimal format) of the AP group"
            },
            "wifi24" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "txPower" : {
                        "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                        "description" : "Transmission power"
                    },
                    "channelWidth" : {
                        "description" : "Channel width (only 20 is currently supported)",
                        "enum" : [ 20 ]
                    },
                    "channel" : {
                        "description" : "Channel number",
                        "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
                    }
                },
                "description" : "AP 2.4GHz radio configuration of the AP group."
            },
            "wifi50" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "txPower" : {
                        "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                        "description" : "Transmission power"
                    },
                    "channelWidth" : {
                        "description" : "Channel width. Zero (0) means Auto.",
                        "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" : "AP 5GHz radio configuration of the AP group."
            },
            "wlanGroup24" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "WLAN group of radio 2.4G. This configuraiton will override the WLAN group of radio 2.4G at the zone level."
            },
            "wlanGroup50" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "WLAN group of radio 5G. This configuration will override the WLAN group of radio 5G at the zone level."
            },
            "locationBasedService" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Location based service configuration of the AP group."
            },
            "clientAdmissionControl24" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "maxRadioLoadPercent" : {
                        "description" : "Maximum radio load percentage.",
                        "type" : "integer",
                        "default" : 75,
                        "minimum" : 50,
                        "maximum" : 100
                    },
                    "minClientCount" : {
                        "description" : "Minimum client count number.",
                        "type" : "integer",
                        "default" : 10,
                        "minimum" : 0,
                        "maximum" : 100
                    },
                    "minClientThroughputMbps" : {
                        "description" : "Minimum client throughput in Mbps.",
                        "type" : "number",
                        "default" : 0,
                        "minimum" : 0,
                        "maximum" : 100
                    }
                },
                "description" : "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level."
            },
            "clientAdmissionControl50" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "maxRadioLoadPercent" : {
                        "description" : "Maximum radio load percentage.",
                        "type" : "integer",
                        "default" : 75,
                        "minimum" : 50,
                        "maximum" : 100
                    },
                    "minClientCount" : {
                        "description" : "Minimum client count number.",
                        "type" : "integer",
                        "default" : 10,
                        "minimum" : 0,
                        "maximum" : 100
                    },
                    "minClientThroughputMbps" : {
                        "description" : "Minimum client throughput in Mbps.",
                        "type" : "number",
                        "default" : 0,
                        "minimum" : 0,
                        "maximum" : 100
                    }
                },
                "description" : "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level."
            },
            "venueProfile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Venue profile configuration of the AP group."
            },
            "members" : {
                "description" : "Members of the AP group",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "apMac" : {
                            "type" : "string",
                            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
                            "description" : "MAC address of member AP"
                        }
                    }
                }
            },
            "autoChannelSelection24" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "channelSelectMode" : {
                        "description" : "Channel Select Mode",
                        "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                    }
                },
                "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
            },
            "autoChannelSelection50" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "channelSelectMode" : {
                        "description" : "Channel Select Mode",
                        "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                    }
                },
                "description" : "client load balancing on Radio 5G, auto channel selection mode"
            },
            "channelEvaluationInterval" : {
                "description" : "channel evaluation Interval of the ap group",
                "type" : "integer",
                "default" : 600,
                "minimum" : 60,
                "maximum" : 3600
            }
        },
        "required" : [ "name" ]
    }
    
    

Create 

/v2_1/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", "null" ],
                "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 

/v2_1/rkszones/{zoneId}/apgroups/{id}

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

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

Disable Location Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/location

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

  • Response  204

Disable Location AdditionalInfo Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/locationAdditionalInfo

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

  • Response  204

Modify Radio 2.4G Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/wifi24

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

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

Disable Radio 2.4G Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/wifi24

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

  • Response  204

Modify Radio 5G Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/wifi50

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

  • Request
  • Body
    {
        "txPower" : "Full",
        "channelWidth" : 40,
        "indoorChannel" : 0,
        "outdoorChannel" : 0
    }
    
    
    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" : "AP 5GHz radio configuration of the AP group."
    }
    
    
  • Response  204

Disable Radio 5G Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/wifi50

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

  • Response  204

Modify WLAN group 2.4G Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup24

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

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

Disable WLAN group 2.4G Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup24

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

  • Response  204

Modify WLAN group 5G Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup50

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

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

Disable WLAN group 5G Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup50

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

  • Response  204

Modify Location Based Service Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/locationBasedService

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

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

Disable Location Based Service Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/locationBasedService

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

  • Response  204

Modify Client Admission Control 2.4G Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl24

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

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

Disable Client Admission Control 2.4G Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl24

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

  • Response  204

Modify Client Admission Control 5G Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl50

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

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

Disable Client Admission Control 5G Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl50

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

  • Response  204

Modify Hotspot2.0 Venue Profile 

/v2_1/rkszones/{zoneId}/apgroups/{id}/venueProfile

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

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

Clear Hotspot2.0 Venue Profile 

/v2_1/rkszones/{zoneId}/apgroups/{id}/venueProfile

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

  • Response  204

Add Member 

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

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

  • Response  201

Remove Member 

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

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

  • Response  204

Retrieve AP Model 

/v2_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}

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

  • Response  200
  • Body
    {
        "ledStatusEnabled" : false,
        "lldp" : {
            "enabled" : true,
            "advertiseIntervalInSec" : 100,
            "holdTimeInSec" : 1000,
            "managementIPTLVEnabled" : false
        },
        "ledMode" : null,
        "internalHeaterEnabled" : null,
        "poeOutPortEnabled" : null,
        "poeModeSetting" : null,
        "usbPowerEnable" : null,
        "radioBand" : null,
        "externalAntenna24" : null,
        "externalAntenna50" : null,
        "lanPorts" : [ {
            "portName" : "LAN1",
            "enabled" : true,
            "type" : "Trunk",
            "vlanUntagId" : 13,
            "members" : "1-4094",
            "_8021X" : {
                "type" : "Disable",
                "authenticator" : null,
                "supplicant" : null
            }
        }, {
            "portName" : "LAN2",
            "enabled" : true,
            "type" : "Access",
            "vlanUntagId" : 15,
            "members" : "15",
            "_8021X" : {
                "type" : "MACBasedAuthenticator",
                "authenticator" : {
                    "authentication" : {
                        "id" : "5f66275c-b1fd-4e25-a4db-b64115740fb9",
                        "name" : "zoneRadius"
                    },
                    "accounting" : {
                        "id" : "b86db5e8-884b-4c90-9315-dcd72acaf743",
                        "name" : "zoneRadiusAcct"
                    },
                    "macAuthByPassEnabled" : true
                },
                "supplicant" : null
            }
        }, {
            "portName" : "LAN3",
            "enabled" : true,
            "type" : "Trunk",
            "vlanUntagId" : 1,
            "members" : "1-4094",
            "_8021X" : {
                "type" : "Supplicant",
                "authenticator" : null,
                "supplicant" : {
                    "type" : "Custom",
                    "userName" : "a",
                    "password" : "a"
                }
            }
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "ledStatusEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "lldp" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "advertiseIntervalInSec" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 1,
                        "maximum" : 300
                    },
                    "holdTimeInSec" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 60,
                        "maximum" : 1200
                    },
                    "managementIPTLVEnabled" : {
                        "type" : [ "boolean", "null" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "ledMode" : {
                "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
            },
            "internalHeaterEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "poeOutPortEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "poeModeSetting" : {
                "enum" : [ null, "Auto", "_802_3af" ]
            },
            "usbPowerEnable" : {
                "type" : [ "boolean", "null" ]
            },
            "radioBand" : {
                "enum" : [ null, "2.4GHz", "5GHz" ]
            },
            "externalAntenna24" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "dbi" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 90
                    },
                    "chainMask" : {
                        "enum" : [ null, "Two", "Three" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "externalAntenna50" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "dbi" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 90
                    },
                    "chainMask" : {
                        "enum" : [ null, "Two", "Three" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "lanPorts" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "portName" : {
                            "enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
                        },
                        "enabled" : {
                            "type" : "boolean"
                        },
                        "type" : {
                            "enum" : [ null, "Access", "Trunk", "General" ]
                        },
                        "vlanUntagId" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 4094
                        },
                        "members" : {
                            "type" : [ "string", "null" ]
                        },
                        "_8021X" : {
                            "type" : [ "object", "null" ],
                            "additionalProperties" : false,
                            "properties" : {
                                "type" : {
                                    "enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
                                },
                                "authenticator" : {
                                    "type" : [ "object", "null" ],
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "authentication" : {
                                            "type" : [ "object", "null" ],
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "id" : {
                                                    "type" : "string"
                                                },
                                                "name" : {
                                                    "type" : "string"
                                                }
                                            }
                                        },
                                        "accounting" : {
                                            "type" : [ "object", "null" ],
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "id" : {
                                                    "type" : "string"
                                                },
                                                "name" : {
                                                    "type" : "string"
                                                }
                                            }
                                        },
                                        "macAuthByPassEnabled" : {
                                            "type" : "boolean"
                                        }
                                    },
                                    "required" : [ "authentication", "macAuthByPassEnabled" ]
                                },
                                "supplicant" : {
                                    "type" : [ "object", "null" ],
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "type" : {
                                            "enum" : [ "MACAddress", "Custom" ]
                                        },
                                        "userName" : {
                                            "type" : [ "string", "null" ],
                                            "maxLength" : 64,
                                            "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
                                        },
                                        "password" : {
                                            "type" : [ "string", "null" ],
                                            "maxLength" : 64,
                                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                                        }
                                    },
                                    "required" : [ "type" ]
                                }
                            },
                            "required" : [ "type" ]
                        }
                    },
                    "required" : [ "portName", "enabled" ]
                }
            }
        }
    }
    
    

Override AP Model 

/v2_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}

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

  • Request
  • Body
    {
        "ledStatusEnabled" : false,
        "lldp" : {
            "enabled" : true,
            "advertiseIntervalInSec" : 100,
            "holdTimeInSec" : 1000,
            "managementIPTLVEnabled" : false
        },
        "ledMode" : null,
        "internalHeaterEnabled" : null,
        "poeOutPortEnabled" : null,
        "poeModeSetting" : null,
        "usbPowerEnable" : null,
        "radioBand" : null,
        "externalAntenna24" : null,
        "externalAntenna50" : null,
        "lanPorts" : [ {
            "portName" : "LAN1",
            "enabled" : true,
            "type" : "Trunk",
            "vlanUntagId" : 13,
            "members" : "1-4094",
            "_8021X" : {
                "type" : "Disable",
                "authenticator" : null,
                "supplicant" : null
            }
        }, {
            "portName" : "LAN2",
            "enabled" : true,
            "type" : "Access",
            "vlanUntagId" : 15,
            "members" : "15",
            "_8021X" : {
                "type" : "MACBasedAuthenticator",
                "authenticator" : {
                    "authentication" : {
                        "id" : "5f66275c-b1fd-4e25-a4db-b64115740fb9",
                        "name" : "zoneRadius"
                    },
                    "accounting" : {
                        "id" : "b86db5e8-884b-4c90-9315-dcd72acaf743",
                        "name" : "zoneRadiusAcct"
                    },
                    "macAuthByPassEnabled" : true
                },
                "supplicant" : null
            }
        }, {
            "portName" : "LAN3",
            "enabled" : true,
            "type" : "Trunk",
            "vlanUntagId" : 1,
            "members" : "1-4094",
            "_8021X" : {
                "type" : "Supplicant",
                "authenticator" : null,
                "supplicant" : {
                    "type" : "Custom",
                    "userName" : "a",
                    "password" : "a"
                }
            }
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "ledStatusEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "lldp" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "advertiseIntervalInSec" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 1,
                        "maximum" : 300
                    },
                    "holdTimeInSec" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 60,
                        "maximum" : 1200
                    },
                    "managementIPTLVEnabled" : {
                        "type" : [ "boolean", "null" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "ledMode" : {
                "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
            },
            "internalHeaterEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "poeOutPortEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "poeModeSetting" : {
                "enum" : [ null, "Auto", "_802_3af" ]
            },
            "usbPowerEnable" : {
                "type" : [ "boolean", "null" ]
            },
            "radioBand" : {
                "enum" : [ null, "2.4GHz", "5GHz" ]
            },
            "externalAntenna24" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "dbi" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 90
                    },
                    "chainMask" : {
                        "enum" : [ null, "Two", "Three" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "externalAntenna50" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "dbi" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 90
                    },
                    "chainMask" : {
                        "enum" : [ null, "Two", "Three" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "lanPorts" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "portName" : {
                            "enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
                        },
                        "enabled" : {
                            "type" : "boolean"
                        },
                        "type" : {
                            "enum" : [ null, "Access", "Trunk", "General" ]
                        },
                        "vlanUntagId" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 4094
                        },
                        "members" : {
                            "type" : [ "string", "null" ]
                        },
                        "_8021X" : {
                            "type" : [ "object", "null" ],
                            "additionalProperties" : false,
                            "properties" : {
                                "type" : {
                                    "enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
                                },
                                "authenticator" : {
                                    "type" : [ "object", "null" ],
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "authentication" : {
                                            "type" : [ "object", "null" ],
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "id" : {
                                                    "type" : "string"
                                                },
                                                "name" : {
                                                    "type" : "string"
                                                }
                                            }
                                        },
                                        "accounting" : {
                                            "type" : [ "object", "null" ],
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "id" : {
                                                    "type" : "string"
                                                },
                                                "name" : {
                                                    "type" : "string"
                                                }
                                            }
                                        },
                                        "macAuthByPassEnabled" : {
                                            "type" : "boolean"
                                        }
                                    },
                                    "required" : [ "authentication", "macAuthByPassEnabled" ]
                                },
                                "supplicant" : {
                                    "type" : [ "object", "null" ],
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "type" : {
                                            "enum" : [ "MACAddress", "Custom" ]
                                        },
                                        "userName" : {
                                            "type" : [ "string", "null" ],
                                            "maxLength" : 64,
                                            "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
                                        },
                                        "password" : {
                                            "type" : [ "string", "null" ],
                                            "maxLength" : 64,
                                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                                        }
                                    },
                                    "required" : [ "type" ]
                                }
                            },
                            "required" : [ "type" ]
                        }
                    },
                    "required" : [ "portName", "enabled" ]
                }
            }
        }
    }
    
    
  • Response  204

Disable Override AP Model 

/v2_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}

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

  • Response  204

Modify Radio 2.4G Auto ChannelSelectMode Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection24

Override Radio 2.4G Auto ChannelSelectMode of an AP group

  • Request
  • Body
    {
        "channelSelectMode" : "ChannelFly"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "channelSelectMode" : {
                "description" : "Channel Select Mode",
                "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
            }
        },
        "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
    }
    
    
  • Response  204

Modify Radio 5G Auto ChannelSelectMode Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection50

Override Radio 5G Auto ChannelSelectMode of an AP group

  • Request
  • Body
    {
        "channelSelectMode" : "BackgroundScanning"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "channelSelectMode" : {
                "description" : "Channel Select Mode",
                "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
            }
        },
        "description" : "client load balancing on Radio 5G, auto channel selection mode"
    }
    
    
  • Response  204

Disable Radio 2.4G Auto ChannelSelectMode Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection24

Disable Radio 2.4G Auto ChannelSelectMode Override of an AP group

  • Response  204

Disable Radio 5G Auto ChannelSelectMode Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection50

Disable Radio 5G Auto ChannelSelectMode Override of an AP group

  • Response  204

Disable Channel Evaluation Interval Override 

/v2_1/rkszones/{zoneId}/apgroups/{id}/channelEvaluationInterval

Disable Channel Evaluation Interval Override of an AP group

  • Response  204

Delete 

/v2_1/rkszones/{zoneId}/apgroups/{id}

Use this API command to delete an AP group.

  • Response  204

Access Point Configuration 

Retrieve List 

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

/v2_1/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,
            "channel" : 1
        },
        "wlanGroup24" : {
            "id" : "wlanGroupUUID",
            "name" : "wlanGroupName"
        },
        "wlanGroup50" : {
            "id" : "wlanGroupUUID",
            "name" : "wlanGroupName"
        },
        "network" : {
            "ipType" : "Static",
            "ip" : "1.1.1.1",
            "netmask" : "255.255.255.0",
            "gateway" : "1.1.1.0",
            "primaryDns" : "8.8.8.8",
            "secondaryDns" : "8.8.8.9"
        },
        "smartMonitor" : {
            "enabled" : true,
            "intervalInSec" : 10,
            "retryThreshold" : 10
        },
        "bonjourGateway" : {
            "id" : "bonjourGatewayUUID",
            "name" : "bonjourGatewayName"
        },
        "specific" : {
            "ledStatusEnabled" : false,
            "lldp" : {
                "enabled" : true,
                "advertiseIntervalInSec" : 100,
                "holdTimeInSec" : 1000,
                "managementIPTLVEnabled" : false
            },
            "ledMode" : null,
            "internalHeaterEnabled" : null,
            "poeOutPortEnabled" : null,
            "poeModeSetting" : null,
            "usbPowerEnable" : null,
            "radioBand" : null,
            "externalAntenna24" : null,
            "externalAntenna50" : null,
            "lanPorts" : [ {
                "portName" : "LAN1",
                "enabled" : true,
                "type" : "Trunk",
                "vlanUntagId" : 13,
                "members" : "1-4094",
                "_8021X" : {
                    "type" : "Disable",
                    "authenticator" : null,
                    "supplicant" : null
                }
            }, {
                "portName" : "LAN2",
                "enabled" : true,
                "type" : "Access",
                "vlanUntagId" : 15,
                "members" : "15",
                "_8021X" : {
                    "type" : "MACBasedAuthenticator",
                    "authenticator" : {
                        "authentication" : {
                            "id" : "5f66275c-b1fd-4e25-a4db-b64115740fb9",
                            "name" : "zoneRadius"
                        },
                        "accounting" : {
                            "id" : "b86db5e8-884b-4c90-9315-dcd72acaf743",
                            "name" : "zoneRadiusAcct"
                        },
                        "macAuthByPassEnabled" : true
                    },
                    "supplicant" : null
                }
            }, {
                "portName" : "LAN3",
                "enabled" : true,
                "type" : "Trunk",
                "vlanUntagId" : 1,
                "members" : "1-4094",
                "_8021X" : {
                    "type" : "Supplicant",
                    "authenticator" : null,
                    "supplicant" : {
                        "type" : "Custom",
                        "userName" : "a",
                        "password" : "a"
                    }
                }
            } ]
        },
        "channelEvaluationInterval" : 777
    }
    
    
    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", "null" ],
                "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."
            },
            "locationAdditionalInfo" : {
                "type" : "string",
                "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                "description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP."
            },
            "provisionChecklist" : {
                "description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
                "type" : "string"
            },
            "administrativeState" : {
                "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
                "enum" : [ "Locked", "Unlocked" ],
                "default" : "Unlocked"
            },
            "wlanService24Enabled" : {
                "description" : "WLAN service enabled or disabled on 2.4GHz radio",
                "type" : "boolean"
            },
            "wlanService50Enabled" : {
                "description" : "WLAN service enabled or disabled on 5GHz radio",
                "type" : "boolean"
            },
            "login" : {
                "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",
                        "description" : "Address of the syslog server. If syslog is enabled, this attribute is required."
                    },
                    "port" : {
                        "description" : "Port number of the syslog server",
                        "type" : "integer",
                        "default" : "514",
                        "minimum" : 1,
                        "maximum" : 65535
                    },
                    "facility" : {
                        "description" : "Facility of the syslog server",
                        "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                    },
                    "priority" : {
                        "description" : "Priority of the log messages",
                        "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                    }
                },
                "required" : [ "enabled" ],
                "description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level."
            },
            "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 (only 20 is currently supported)",
                        "enum" : [ 20 ]
                    },
                    "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, 0 mean Auto",
                        "enum" : [ 0, 20, 40, 80 ]
                    },
                    "channel" : {
                        "description" : "channel number",
                        "enum" : [ 0, 36, 40, 44, 48, 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",
                        "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",
                        "description" : "Gateway of the AP"
                    },
                    "primaryDns" : {
                        "type" : "string",
                        "description" : "Primary DNS server address of the AP"
                    },
                    "secondaryDns" : {
                        "type" : "string",
                        "description" : "Secondary DNS server address of the AP"
                    }
                },
                "description" : "Network settings of the AP."
            },
            "smartMonitor" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "intervalInSec" : {
                        "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                        "type" : "integer",
                        "default" : 10,
                        "minimum" : 5,
                        "maximum" : 60
                    },
                    "retryThreshold" : {
                        "description" : "Retry threshold. This is required if smartMonitor is enabled",
                        "type" : "integer",
                        "default" : 3,
                        "minimum" : 1,
                        "maximum" : 10
                    }
                },
                "description" : "Smart monitor of the AP."
            },
            "bonjourGateway" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Bonjour gateway of the AP."
            },
            "clientAdmissionControl24" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "maxRadioLoadPercent" : {
                        "description" : "Maximum radio load percentage.",
                        "type" : "integer",
                        "default" : 75,
                        "minimum" : 50,
                        "maximum" : 100
                    },
                    "minClientCount" : {
                        "description" : "Minimum client count number.",
                        "type" : "integer",
                        "default" : 10,
                        "minimum" : 0,
                        "maximum" : 100
                    },
                    "minClientThroughputMbps" : {
                        "description" : "Minimum client throughput in Mbps.",
                        "type" : "number",
                        "default" : 0,
                        "minimum" : 0,
                        "maximum" : 100
                    }
                },
                "description" : "Client admission control configuration of 2.4GHz radio of the AP."
            },
            "clientAdmissionControl50" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "maxRadioLoadPercent" : {
                        "description" : "Maximum radio load percentage.",
                        "type" : "integer",
                        "default" : 75,
                        "minimum" : 50,
                        "maximum" : 100
                    },
                    "minClientCount" : {
                        "description" : "Minimum client count number.",
                        "type" : "integer",
                        "default" : 10,
                        "minimum" : 0,
                        "maximum" : 100
                    },
                    "minClientThroughputMbps" : {
                        "description" : "Minimum client throughput in Mbps.",
                        "type" : "number",
                        "default" : 0,
                        "minimum" : 0,
                        "maximum" : 100
                    }
                },
                "description" : "Client admission control configuration of 5GHz radio of the AP."
            },
            "venueProfile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Venue profile configuration of the AP."
            },
            "specific" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "ledStatusEnabled" : {
                        "type" : [ "boolean", "null" ]
                    },
                    "lldp" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "enabled" : {
                                "type" : "boolean"
                            },
                            "advertiseIntervalInSec" : {
                                "type" : [ "integer", "null" ],
                                "minimum" : 1,
                                "maximum" : 300
                            },
                            "holdTimeInSec" : {
                                "type" : [ "integer", "null" ],
                                "minimum" : 60,
                                "maximum" : 1200
                            },
                            "managementIPTLVEnabled" : {
                                "type" : [ "boolean", "null" ]
                            }
                        },
                        "required" : [ "enabled" ]
                    },
                    "ledMode" : {
                        "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
                    },
                    "internalHeaterEnabled" : {
                        "type" : [ "boolean", "null" ]
                    },
                    "poeOutPortEnabled" : {
                        "type" : [ "boolean", "null" ]
                    },
                    "poeModeSetting" : {
                        "enum" : [ null, "Auto", "_802_3af" ]
                    },
                    "usbPowerEnable" : {
                        "type" : [ "boolean", "null" ]
                    },
                    "radioBand" : {
                        "enum" : [ null, "2.4GHz", "5GHz" ]
                    },
                    "externalAntenna24" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "enabled" : {
                                "type" : "boolean"
                            },
                            "dbi" : {
                                "type" : [ "integer", "null" ],
                                "minimum" : 0,
                                "maximum" : 90
                            },
                            "chainMask" : {
                                "enum" : [ null, "Two", "Three" ]
                            }
                        },
                        "required" : [ "enabled" ]
                    },
                    "externalAntenna50" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "enabled" : {
                                "type" : "boolean"
                            },
                            "dbi" : {
                                "type" : [ "integer", "null" ],
                                "minimum" : 0,
                                "maximum" : 90
                            },
                            "chainMask" : {
                                "enum" : [ null, "Two", "Three" ]
                            }
                        },
                        "required" : [ "enabled" ]
                    },
                    "lanPorts" : {
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "portName" : {
                                    "enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
                                },
                                "enabled" : {
                                    "type" : "boolean"
                                },
                                "type" : {
                                    "enum" : [ null, "Access", "Trunk", "General" ]
                                },
                                "vlanUntagId" : {
                                    "type" : [ "integer", "null" ],
                                    "minimum" : 0,
                                    "maximum" : 4094
                                },
                                "members" : {
                                    "type" : [ "string", "null" ]
                                },
                                "_8021X" : {
                                    "type" : [ "object", "null" ],
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "type" : {
                                            "enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
                                        },
                                        "authenticator" : {
                                            "type" : [ "object", "null" ],
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "authentication" : {
                                                    "type" : [ "object", "null" ],
                                                    "additionalProperties" : false,
                                                    "properties" : {
                                                        "id" : {
                                                            "type" : "string"
                                                        },
                                                        "name" : {
                                                            "type" : "string"
                                                        }
                                                    }
                                                },
                                                "accounting" : {
                                                    "type" : [ "object", "null" ],
                                                    "additionalProperties" : false,
                                                    "properties" : {
                                                        "id" : {
                                                            "type" : "string"
                                                        },
                                                        "name" : {
                                                            "type" : "string"
                                                        }
                                                    }
                                                },
                                                "macAuthByPassEnabled" : {
                                                    "type" : "boolean"
                                                }
                                            },
                                            "required" : [ "authentication", "macAuthByPassEnabled" ]
                                        },
                                        "supplicant" : {
                                            "type" : [ "object", "null" ],
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "type" : {
                                                    "enum" : [ "MACAddress", "Custom" ]
                                                },
                                                "userName" : {
                                                    "type" : [ "string", "null" ],
                                                    "maxLength" : 64,
                                                    "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
                                                },
                                                "password" : {
                                                    "type" : [ "string", "null" ],
                                                    "maxLength" : 64,
                                                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                                                }
                                            },
                                            "required" : [ "type" ]
                                        }
                                    },
                                    "required" : [ "type" ]
                                }
                            },
                            "required" : [ "portName", "enabled" ]
                        }
                    }
                },
                "description" : "Model specific configuration of the AP"
            },
            "channelEvaluationInterval" : {
                "description" : "channel evaluation Interval of the AP",
                "type" : "integer",
                "default" : 600,
                "minimum" : 60,
                "maximum" : 3600
            }
        }
    }
    
    

Retrieve AP Picture 

/v2_1/aps/{apMac}/picture

Use this API command to retrieve the current AP picture.

  • Response  200
  • Body
    Binary data for the picture
    
    

Create 

/v2_1/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", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the AP"
            },
            "administrativeState" : {
                "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
                "enum" : [ "Locked", "Unlocked" ],
                "default" : "Unlocked"
            },
            "provisionChecklist" : {
                "description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
                "type" : "string"
            }
        },
        "required" : [ "mac", "zoneId" ]
    }
    
    
  • Response  201

Modify Basic 

/v2_1/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",
        "locationAdditionalInfo" : "locationAdditionalInfo",
        "description" : "apDescription",
        "administrativeState" : "Unlocked",
        "provisionChecklist" : "provisionChecklist",
        "wlanService24Enabled" : true,
        "wlanService50Enabled" : null,
        "channelEvaluationInterval" : 777
    }
    
    
    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."
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP."
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the AP"
        },
        "administrativeState" : {
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "enum" : [ "Locked", "Unlocked" ]
        },
        "provisionChecklist" : {
            "description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
            "type" : "string"
        },
        "wlanService24Enabled" : {
            "description" : "WLAN service enabled or disabled on 2.4GHz radio",
            "type" : "boolean"
        },
        "wlanService50Enabled" : {
            "description" : "WLAN service enabled or disabled on 5GHz radio",
            "type" : "boolean"
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the AP",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        }
    }
    
    
  • Response  204

Diable Location Override 

/v2_1/aps/{apMac}/location

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

  • Response  204

Diable Location AdditionalInfo Override 

/v2_1/aps/{apMac}/locationAdditionalInfo

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

  • Response  204

Modify Login Override 

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

/v2_1/aps/{apMac}/login

Use this API command to disable the AP-level logon override. The AP will apply its group’s or zone’s configuration.

  • Response  204

Modify Syslog Override 

/v2_1/aps/{apMac}/syslog

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

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

Diable Syslog Override 

/v2_1/aps/{apMac}/syslog

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

  • Response  204

Modify Radio 2.4G Override 

/v2_1/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 (only 20 is currently supported)",
                "enum" : [ 20 ]
            },
            "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 

/v2_1/aps/{apMac}/wifi24

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

  • Response  204

Modify Radio 5G Override 

/v2_1/aps/{apMac}/wifi50

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

  • Request
  • Body
    {
        "txPower" : "txPower",
        "channelWidth" : 1,
        " channel" : 1
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "txPower" : {
                "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                "description" : "transmission power"
            },
            "channelWidth" : {
                "description" : "channel width, 0 mean Auto",
                "enum" : [ 0, 20, 40, 80 ]
            },
            "channel" : {
                "description" : "channel number",
                "enum" : [ 0, 36, 40, 44, 48, 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 

/v2_1/aps/{apMac}/wifi50

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

  • Response  204

Modify WLAN Group 2.4G Override 

/v2_1/aps/{apMac}/wlanGroup24

Use this API command to enable or modify the AP level override of the WLAN group configuration on the 2.4GHz radio.

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

/v2_1/aps/{apMac}/wlanGroup24

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

  • Response  204

Modify WLAN Group 5G Override 

/v2_1/aps/{apMac}/wlanGroup50

Use this API command to enable or modify the AP level override of the WLAN group configuration on the 5GHz radio.

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

/v2_1/aps/{apMac}/wlanGroup50

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

  • Response  204

Modify Network Settings 

/v2_1/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",
                "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",
                "description" : "Gateway of the AP"
            },
            "primaryDns" : {
                "type" : "string",
                "description" : "Primary DNS server address of the AP"
            },
            "secondaryDns" : {
                "type" : "string",
                "description" : "Secondary DNS server address of the AP"
            }
        },
        "description" : "Network settings of the AP."
    }
    
    
  • Response  204

Modify Smart Monitor 

/v2_1/aps/{apMac}/smartMonitor

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

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

Disable Smart Monitor Override 

/v2_1/aps/{apMac}/smartMonitor

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

  • Response  204

Modify Bonjour Gateway 

/v2_1/aps/{apMac}/bonjourGateway

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

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

Disable Bonjour Gateway Override 

/v2_1/aps/{apMac}/bonjourGateway

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

  • Response  204

Modify Client Admission Control 2.4G 

/v2_1/aps/{apMac}/clientAdmissionControl24

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

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

Disable Client Admission Control 2.4G Override 

/v2_1/aps/{apMac}/clientAdmissionControl24

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

  • Response  204

Modify Client Admission Control 5G 

/v2_1/aps/{apMac}/clientAdmissionControl50

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

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

Disable Client Admission Control 5G Override 

/v2_1/aps/{apMac}/clientAdmissionControl50

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

  • Response  204

Modify Venue Profile 

/v2_1/aps/{apMac}/venueProfile

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

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

Disable Venue Profile Override 

/v2_1/aps/{apMac}/venueProfile

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

  • Response  204

Modify Model Specific 

/v2_1/aps/{apMac}/specific

Use this API command to modify model specific configuration.

  • Request
  • Body
    {
        "ledStatusEnabled" : false,
        "lldp" : {
            "enabled" : true,
            "advertiseIntervalInSec" : 100,
            "holdTimeInSec" : 1000,
            "managementIPTLVEnabled" : false
        },
        "ledMode" : null,
        "internalHeaterEnabled" : null,
        "poeOutPortEnabled" : null,
        "poeModeSetting" : null,
        "usbPowerEnable" : null,
        "radioBand" : null,
        "externalAntenna24" : null,
        "externalAntenna50" : null,
        "lanPorts" : [ {
            "portName" : "LAN1",
            "enabled" : true,
            "type" : "Trunk",
            "vlanUntagId" : 13,
            "members" : "1-4094",
            "_8021X" : {
                "type" : "Disable",
                "authenticator" : null,
                "supplicant" : null
            }
        }, {
            "portName" : "LAN2",
            "enabled" : true,
            "type" : "Access",
            "vlanUntagId" : 15,
            "members" : "15",
            "_8021X" : {
                "type" : "MACBasedAuthenticator",
                "authenticator" : {
                    "authentication" : {
                        "id" : "5f66275c-b1fd-4e25-a4db-b64115740fb9",
                        "name" : "zoneRadius"
                    },
                    "accounting" : {
                        "id" : "b86db5e8-884b-4c90-9315-dcd72acaf743",
                        "name" : "zoneRadiusAcct"
                    },
                    "macAuthByPassEnabled" : true
                },
                "supplicant" : null
            }
        }, {
            "portName" : "LAN3",
            "enabled" : true,
            "type" : "Trunk",
            "vlanUntagId" : 1,
            "members" : "1-4094",
            "_8021X" : {
                "type" : "Supplicant",
                "authenticator" : null,
                "supplicant" : {
                    "type" : "Custom",
                    "userName" : "a",
                    "password" : "a"
                }
            }
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "ledStatusEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "lldp" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "advertiseIntervalInSec" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 1,
                        "maximum" : 300
                    },
                    "holdTimeInSec" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 60,
                        "maximum" : 1200
                    },
                    "managementIPTLVEnabled" : {
                        "type" : [ "boolean", "null" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "ledMode" : {
                "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
            },
            "internalHeaterEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "poeOutPortEnabled" : {
                "type" : [ "boolean", "null" ]
            },
            "poeModeSetting" : {
                "enum" : [ null, "Auto", "_802_3af" ]
            },
            "usbPowerEnable" : {
                "type" : [ "boolean", "null" ]
            },
            "radioBand" : {
                "enum" : [ null, "2.4GHz", "5GHz" ]
            },
            "externalAntenna24" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "dbi" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 90
                    },
                    "chainMask" : {
                        "enum" : [ null, "Two", "Three" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "externalAntenna50" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "dbi" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 90
                    },
                    "chainMask" : {
                        "enum" : [ null, "Two", "Three" ]
                    }
                },
                "required" : [ "enabled" ]
            },
            "lanPorts" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "portName" : {
                            "enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
                        },
                        "enabled" : {
                            "type" : "boolean"
                        },
                        "type" : {
                            "enum" : [ null, "Access", "Trunk", "General" ]
                        },
                        "vlanUntagId" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 4094
                        },
                        "members" : {
                            "type" : [ "string", "null" ]
                        },
                        "_8021X" : {
                            "type" : [ "object", "null" ],
                            "additionalProperties" : false,
                            "properties" : {
                                "type" : {
                                    "enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
                                },
                                "authenticator" : {
                                    "type" : [ "object", "null" ],
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "authentication" : {
                                            "type" : [ "object", "null" ],
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "id" : {
                                                    "type" : "string"
                                                },
                                                "name" : {
                                                    "type" : "string"
                                                }
                                            }
                                        },
                                        "accounting" : {
                                            "type" : [ "object", "null" ],
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "id" : {
                                                    "type" : "string"
                                                },
                                                "name" : {
                                                    "type" : "string"
                                                }
                                            }
                                        },
                                        "macAuthByPassEnabled" : {
                                            "type" : "boolean"
                                        }
                                    },
                                    "required" : [ "authentication", "macAuthByPassEnabled" ]
                                },
                                "supplicant" : {
                                    "type" : [ "object", "null" ],
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "type" : {
                                            "enum" : [ "MACAddress", "Custom" ]
                                        },
                                        "userName" : {
                                            "type" : [ "string", "null" ],
                                            "maxLength" : 64,
                                            "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
                                        },
                                        "password" : {
                                            "type" : [ "string", "null" ],
                                            "maxLength" : 64,
                                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                                        }
                                    },
                                    "required" : [ "type" ]
                                }
                            },
                            "required" : [ "type" ]
                        }
                    },
                    "required" : [ "portName", "enabled" ]
                }
            }
        }
    }
    
    
  • Response  204

Disable Model Specific Override 

/v2_1/aps/{apMac}/specific

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

  • Response  204

Upload AP Picture 

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

/v2_1/aps/{apMac}/picture

Use this API command to modify an AP picture

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

Delete AP Picture 

/v2_1/aps/{apMac}/picture

Use this API command to delete an AP picture.

  • Response  204

Disable AP Channel Evaluation Interval 

/v2_1/aps/{apMac}/channelEvaluationInterval

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

  • Response  204

Delete 

/v2_1/aps/{apMac}

Use this API command to delete an access point.

  • Response  204

Reboot 

/v2_1/aps/{apMac}/reboot

reboot an access point

  • Response  204

Access Point Operational 

Retrieve Operational Information 

/v2_1/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",
        "ipv6Type" : null,
        "ipv6" : null,
        "externalIp" : "172.18.11.11",
        "externalPort" : 675,
        "configState" : "newConfig",
        "connectionState" : "Connected",
        "registrationState" : "Approved",
        "administrativeState" : "Unlocked",
        "provisionMethod" : "Discovered",
        "provisionStage" : "Waiting for Registration",
        "isCriticalAP" : true,
        "approvedTime" : 111111,
        "lastSeenTime" : 111111,
        "uptime" : 111111,
        "clientCount" : 2
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "mac" : {
                "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", "null" ],
                "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 

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

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

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

    severity
    string (optional) 

    filter by severity

    category
    string (optional) 

    filter by category

    code
    number (optional) 

    filter by alarm code

    startTime
    string (optional) 

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

    endTime
    string (optional) 

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

    status
    string (optional) 

    filter by alarm status

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

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

    severity
    string (optional) 

    filter by severity

    category
    string (optional) 

    filter by category

    code
    number (optional) 

    filter by event code

    startTime
    string (optional) 

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

    endTime
    string (optional) 

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

  • 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"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve Mesh Neighbor AP List 

/v2_1/aps/{apMac}/operational/neighbor

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

WLAN Group 

Retrieve List 

/v2_1/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",
            "name" : "wlanGroupName",
            "description" : "wlanGroupDescription",
            "members" : [ {
                "id" : "wlanUUID",
                "accessVlan" : 1,
                "nasId" : "nasId",
                "vlanPooling" : null
            } ]
        }, {
            "id" : "wlanGroupUUID2",
            "zoneId" : "zoneUUID",
            "name" : "wlanGroupName2",
            "description" : "wlanGroupDescription2",
            "members" : [ {
                "id" : "wlanUUID2",
                "accessVlan" : 1,
                "nasId" : "nasId",
                "vlanPooling" : null
            } ]
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the WLAN group",
                            "type" : "string"
                        },
                        "zoneId" : {
                            "description" : "Identifier of the zone to which the WLAN group belongs",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the WLAN group"
                        },
                        "description" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 64,
                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                            "description" : "Description of the WLAN group"
                        },
                        "members" : {
                            "description" : "Members of the WLAN group",
                            "type" : "array",
                            "items" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "properties" : {
                                    "id" : {
                                        "description" : "Identifier of the WLAN",
                                        "type" : "string"
                                    },
                                    "accessVlan" : {
                                        "description" : "Access VLAN",
                                        "type" : "integer",
                                        "minimum" : 1,
                                        "maximum" : 4094
                                    },
                                    "vlanPooling" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        },
                                        "description" : "Vlan pooling"
                                    },
                                    "nasId" : {
                                        "description" : "NAS-ID",
                                        "type" : "string",
                                        "maxLength" : 63,
                                        "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
                                    }
                                },
                                "required" : [ "id" ]
                            }
                        }
                    },
                    "required" : [ "name" ]
                }
            }
        }
    }
    
    

Retrieve 

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

Create 

/v2_1/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", "null" ],
                "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 

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

Add Member 

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

Modify Member 

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

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

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

Modify Member VLAN Pooling 

/v2_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/vlanPooling

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

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

Disable Member VLAN Override 

/v2_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/vlanOverride

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

  • Response  204

Disable Member NAS Override 

/v2_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/nasId

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

  • Response  204

Remove Member 

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

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

  • Response  204

Delete 

/v2_1/rkszones/{zoneId}/wlangroups/{id}

Use this API command to delete a WLAN group.

  • Response  204

WLAN 

Retrieve List 

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

/v2_1/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,
            "accountingDelayEnabled" : null
        },
        "accessTunnelType" : "APLBO",
        "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"
        },
        "qosMaps" : [ {
            "enable" : true,
            "priority" : 0,
            "low" : 0,
            "high" : 7,
            "excepts" : null
        }, {
            "enable" : true,
            "priority" : 1,
            "low" : 8,
            "high" : 15,
            "excepts" : null
        }, {
            "enable" : true,
            "priority" : 2,
            "low" : 16,
            "high" : 23,
            "excepts" : null
        }, {
            "enable" : true,
            "priority" : 3,
            "low" : 0,
            "high" : 32,
            "excepts" : [ 43, 45, 60 ]
        }, {
            "enable" : true,
            "priority" : 4,
            "low" : 32,
            "high" : 39,
            "excepts" : null
        }, {
            "enable" : true,
            "priority" : 5,
            "low" : 40,
            "high" : 47,
            "excepts" : null
        }, {
            "enable" : true,
            "priority" : 6,
            "low" : 48,
            "high" : 55,
            "excepts" : [ 46 ]
        }, {
            "enable" : true,
            "priority" : 7,
            "low" : 56,
            "high" : 63,
            "excepts" : null
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the WLAN",
                "type" : "string"
            },
            "zoneId" : {
                "description" : "Identifier of the zone to which the WLAN belongs",
                "type" : "string"
            },
            "name" : {
                "description" : "Name of the WLAN",
                "type" : "string"
            },
            "ssid" : {
                "description" : "SSID of the WLAN",
                "type" : "string"
            },
            "hessid" : {
                "type" : "string",
                "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
                "description" : "HESSID of the WLAN"
            },
            "description" : {
                "description" : "Description of the WLAN",
                "type" : "string"
            },
            "type" : {
                "description" : "Type of the WLAN",
                "enum" : [ "Standard_Open", "Standard_80211", "Standard_Mac", "Hotspot", "Hotspot_MacByPass", "Guest", "WebAuth", "Hotspot20", "Hotspot20_OSEN" ]
            },
            "bypassCNA" : {
                "description" : "By pass Capitive Network Assitance",
                "type" : [ "boolean", "null" ]
            },
            "encryption" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "method" : {
                        "description" : "Encryption method",
                        "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                    },
                    "algorithm" : {
                        "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                        "enum" : [ "AES", "TKIP_AES" ]
                    },
                    "passphrase" : {
                        "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                        "type" : "string"
                    },
                    "mfp" : {
                        "description" : "Management frame protection. This only applies to WPA2 + AES",
                        "enum" : [ "disabled", "capable", "required" ]
                    },
                    "keyIndex" : {
                        "description" : "Key index. This only applies to WEP64 and WEP128.",
                        "type" : "integer"
                    },
                    "keyInHex" : {
                        "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                        "type" : "string"
                    }
                },
                "required" : [ "method" ],
                "description" : "Encryption of the WLAN"
            },
            "authServiceOrProfile" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "throughController" : {
                        "description" : "Indicates whether authentication messages were sent through the controller or not",
                        "type" : "boolean"
                    },
                    "id" : {
                        "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                        "type" : "string"
                    },
                    "locationDeliveryEnabled" : {
                        "description" : "RFC5580 location delivery support",
                        "type" : "boolean"
                    }
                },
                "description" : "Autentication of 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"
                    }
                },
                "description" : "Accounting of the WLAN"
            },
            "accessTunnelType" : {
                "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, SoftGRE means AP direct SoftGRE tunnel",
                "enum" : [ "APLBO", "SoftGRE" ]
            },
            "portalServiceProfile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs."
            },
            "hotspot20Profile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
            },
            "defaultUserTrafficProfile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "User traffic profile of the WLAN"
            },
            "vlan" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "accessVlan" : {
                        "description" : "Access VLAN ID",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 4094
                    },
                    "dynamicVlanEnabled" : {
                        "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                        "type" : "boolean"
                    },
                    "vlanPooling" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        },
                        "description" : "Vlan pooling"
                    }
                },
                "description" : "VLAN (access and/or core) of the WLAN."
            },
            "l2ACL" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Layer 2 ACL of the WLAN"
            },
            "devicePolicy" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Device policy of the WLAN"
            },
            "radiusOptions" : {
                "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)"
                    },
                    "zeroItActivationEnabled" : {
                        "description" : "Indicator of whether Zero-IT activation is enabled or disabled",
                        "type" : "boolean",
                        "default" : false
                    },
                    "pmkCachingEnabled" : {
                        "description" : "Indicator of whether PKM caching support is enabled or disabled",
                        "type" : "boolean",
                        "default" : false
                    },
                    "okcEnabled" : {
                        "description" : "Indicator of whether OKC support is enabled or disabled",
                        "type" : "boolean",
                        "default" : false
                    }
                },
                "description" : "Advanced settings for the WLAN."
            },
            "diffServProfile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "DiffServ profile of the WLAN"
            },
            "qosMaps" : {
                "description" : "Qos map set of the WLAN.",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "enable" : {
                            "description" : "Enabled or disabled",
                            "type" : "boolean"
                        },
                        "priority" : {
                            "description" : "Priority",
                            "type" : "integer"
                        },
                        "low" : {
                            "description" : "DSCP range - low",
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 255
                        },
                        "high" : {
                            "description" : "DSCP range - high",
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 255
                        },
                        "excepts" : {
                            "type" : [ "array", "null" ],
                            "items" : {
                                "type" : "integer",
                                "minimum" : 0,
                                "maximum" : 63
                            }
                        }
                    },
                    "required" : [ "enable", "priority" ]
                }
            },
            "onlineSignupService" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "zeroITOnboarding" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "portal" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "id" : {
                                        "type" : "string"
                                    },
                                    "name" : {
                                        "type" : "string"
                                    }
                                },
                                "description" : "Onboarding portal profile"
                            },
                            "authServices" : {
                                "description" : "Authentication services",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "id" : {
                                            "description" : "Identifier of authentication service",
                                            "type" : "string"
                                        },
                                        "name" : {
                                            "description" : "Authentication service name",
                                            "type" : "string"
                                        },
                                        "credentialType" : {
                                            "description" : "Provisioning credential type",
                                            "enum" : [ "LOCAL", "REMOTE" ]
                                        },
                                        "realm" : {
                                            "type" : "string",
                                            "maxLength" : 255,
                                            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                            "description" : "Device provisioning realm"
                                        },
                                        "expiration" : {
                                            "description" : "Expiration hour. null mean never expire",
                                            "type" : [ "integer", "null" ],
                                            "minimum" : 1,
                                            "maximum" : 175200
                                        }
                                    },
                                    "required" : [ "credentialType", "realm" ]
                                }
                            }
                        },
                        "required" : [ "portal", "authServices" ],
                        "description" : "Zero-IT Onboarding"
                    },
                    "onlineSignupEnabled" : {
                        "description" : "Hotspot 2.0 online signup enabled device registration from this guest portal",
                        "type" : "boolean",
                        "default" : false
                    }
                },
                "description" : "Online signup service, only support for guest access WLAN"
            }
        }
    }
    
    

Create - Standard Open 

/v2_1/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"
            },
            "hessid" : {
                "type" : "string",
                "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
                "description" : "HESSID of the WLAN"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            }
        },
        "required" : [ "name", "ssid" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create - 802.1X 

/v2_1/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"
            },
            "hessid" : {
                "type" : "string",
                "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
                "description" : "HESSID of the WLAN"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            },
            "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"
                    },
                    "locationDeliveryEnabled" : {
                        "description" : "RFC5580 location delivery support",
                        "type" : "boolean"
                    }
                },
                "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required."
            }
        },
        "required" : [ "name", "ssid", "authServiceOrProfile" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create - MAC Auth 

/v2_1/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"
            },
            "hessid" : {
                "type" : "string",
                "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
                "description" : "HESSID of the WLAN"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            },
            "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"
                    },
                    "locationDeliveryEnabled" : {
                        "description" : "RFC5580 location delivery support",
                        "type" : "boolean"
                    }
                },
                "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required."
            }
        },
        "required" : [ "name", "ssid", "authServiceOrProfile" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create - Hotspot 

/v2_1/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"
            },
            "hessid" : {
                "type" : "string",
                "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
                "description" : "HESSID of the WLAN"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            },
            "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"
                    },
                    "locationDeliveryEnabled" : {
                        "description" : "RFC5580 location delivery support",
                        "type" : "boolean"
                    }
                },
                "description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required."
            },
            "portalServiceProfile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required."
            }
        },
        "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create - Hotspot + MAC bypass 

/v2_1/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"
            },
            "hessid" : {
                "type" : "string",
                "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
                "description" : "HESSID of the WLAN"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            },
            "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"
                    },
                    "locationDeliveryEnabled" : {
                        "description" : "RFC5580 location delivery support",
                        "type" : "boolean"
                    }
                },
                "description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required."
            },
            "portalServiceProfile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required."
            }
        },
        "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create - Guest Access 

/v2_1/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"
            },
            "hessid" : {
                "type" : "string",
                "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
                "description" : "HESSID of the WLAN"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            },
            "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"
                    },
                    "locationDeliveryEnabled" : {
                        "description" : "RFC5580 location delivery support",
                        "type" : "boolean"
                    }
                },
                "description" : "Authentication of the WLAN. Guest WLANs only accept two names: Local DB and Always Accept."
            },
            "portalServiceProfile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Guest portal service of the WLAN. The ID or name of the guest portal services within the zone is required."
            }
        },
        "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create - Web Auth 

/v2_1/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"
            },
            "hessid" : {
                "type" : "string",
                "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
                "description" : "HESSID of the WLAN"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            },
            "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"
                    },
                    "locationDeliveryEnabled" : {
                        "description" : "RFC5580 location delivery support",
                        "type" : "boolean"
                    }
                },
                "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required."
            },
            "portalServiceProfile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Web authorizationn portal service of the WLAN. The ID or name of the guest portal services within the zone is required."
            }
        },
        "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create - Hotspot 2.0 

/v2_1/rkszones/{zoneId}/wlans/hotspot20

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

  • Request
  • Body
    {
        "name" : "wlanName",
        "ssid" : "wlanSSID",
        "description" : "wlanDescription",
        "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"
            },
            "hessid" : {
                "type" : "string",
                "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
                "description" : "HESSID of the WLAN"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            },
            "hotspot20Profile" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Hotspot 2.0 operator profile of the WLAN. The ID or name of the Hotspot 2.0 operator profiles within the zone is required."
            }
        },
        "required" : [ "name", "ssid", "hotspot20Profile" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create - Hotspot 2.0 OSEN 

/v2_1/rkszones/{zoneId}/wlans/hotspot20osen

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

  • Request
  • Body
    {
        "name" : "api-test-wlanhs20osen",
        "ssid" : "api-test-wlanhs20osen",
        "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"
            },
            "hessid" : {
                "type" : "string",
                "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
                "description" : "HESSID of the WLAN"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN"
            }
        },
        "required" : [ "name", "ssid" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v2_1/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" : "SoftGRE"
    }
    
    
    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"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "bypassCNA" : {
            "description" : "By pass Capitive Network Assitance",
            "type" : [ "boolean", "null" ]
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "enum" : [ "APLBO", "SoftGRE" ]
        }
    }
    
    
  • Response  204

Modify Authentication 

/v2_1/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"
            },
            "locationDeliveryEnabled" : {
                "description" : "RFC5580 location delivery support",
                "type" : "boolean"
            }
        },
        "description" : "Authentication of the WLAN"
    }
    
    
  • Response  204

Modify MAC Auth 

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

/v2_1/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
    }
    
    
    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"
            }
        },
        "description" : "Accounting of the WLAN"
    }
    
    
  • Response  204

Disable Accounting 

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

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

  • Response  204

Modify Encryption 

/v2_1/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"
            },
            "mfp" : {
                "description" : "Management frame protection. This only applies to WPA2 + AES",
                "enum" : [ "disabled", "capable", "required" ]
            },
            "keyIndex" : {
                "description" : "Key index. This only applies to WEP64 and WEP128.",
                "type" : "integer"
            },
            "keyInHex" : {
                "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                "type" : "string"
            }
        },
        "required" : [ "method" ],
        "description" : "Encryption of the WLAN"
    }
    
    
  • Response  204

Modify Portal Profile 

/v2_1/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", "null" ],
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            },
            "name" : {
                "type" : "string"
            }
        },
        "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs."
    }
    
    
  • Response  204

Modify Hotspot20 Profile 

/v2_1/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", "null" ],
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            },
            "name" : {
                "type" : "string"
            }
        },
        "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
    }
    
    
  • Response  204

Modify User Traffic Profile 

/v2_1/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", "null" ],
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            },
            "name" : {
                "type" : "string"
            }
        },
        "description" : "User traffic profile of the WLAN"
    }
    
    
  • Response  204

Modify Schedule 

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

/v2_1/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" : 1,
                "maximum" : 4094
            },
            "dynamicVlanEnabled" : {
                "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                "type" : "boolean"
            },
            "vlanPooling" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Vlan pooling"
            }
        },
        "description" : "VLAN (access and/or core) of the WLAN."
    }
    
    
  • Response  204

Modify Layer 2 ACL 

/v2_1/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", "null" ],
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            },
            "name" : {
                "type" : "string"
            }
        },
        "description" : "Layer 2 ACL of the WLAN"
    }
    
    
  • Response  204

Disable Layer 2 ACL 

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

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

  • Response  204

Modify Device Policy 

/v2_1/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", "null" ],
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            },
            "name" : {
                "type" : "string"
            }
        },
        "description" : "Device policy of the WLAN"
    }
    
    
  • Response  204

Disable Device Policy 

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

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

  • Response  204

Modify RADIUS Options 

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

/v2_1/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)"
            },
            "zeroItActivationEnabled" : {
                "description" : "Indicator of whether Zero-IT activation is enabled or disabled",
                "type" : "boolean",
                "default" : false
            },
            "pmkCachingEnabled" : {
                "description" : "Indicator of whether PKM caching support is enabled or disabled",
                "type" : "boolean",
                "default" : false
            },
            "okcEnabled" : {
                "description" : "Indicator of whether OKC support is enabled or disabled",
                "type" : "boolean",
                "default" : false
            }
        },
        "description" : "Advanced settings for the WLAN."
    }
    
    
  • Response  204

Modify DiffServ Profile 

/v2_1/rkszones/{zoneId}/wlans/{id}/diffServProfile

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

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

Disable DiffServ Profile 

/v2_1/rkszones/{zoneId}/wlans/{id}/diffServProfile

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

  • Response  204

Enable Qos Map Set 

/v2_1/rkszones/{zoneId}/wlans/{id}/qosMaps

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

  • Response  201

Modify Qos Map Set 

/v2_1/rkszones/{zoneId}/wlans/{id}/qosMaps

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

  • Request
  • Body
    [ {
        "enable" : true,
        "priority" : 0,
        "low" : 0,
        "high" : 7,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 1,
        "low" : 8,
        "high" : 15,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 2,
        "low" : 16,
        "high" : 23,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 3,
        "low" : 0,
        "high" : 32,
        "excepts" : [ 43, 45, 60 ]
    }, {
        "enable" : true,
        "priority" : 4,
        "low" : 32,
        "high" : 39,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 5,
        "low" : 40,
        "high" : 47,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 6,
        "low" : 48,
        "high" : 55,
        "excepts" : [ 46 ]
    }, {
        "enable" : true,
        "priority" : 7,
        "low" : 56,
        "high" : 63,
        "excepts" : null
    } ]
    
    
    Schema
    {
        "description" : "Qos map set of the WLAN.",
        "type" : "array",
        "items" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enable" : {
                    "description" : "Enabled or disabled",
                    "type" : "boolean"
                },
                "priority" : {
                    "description" : "Priority",
                    "type" : "integer"
                },
                "low" : {
                    "description" : "DSCP range - low",
                    "type" : [ "integer", "null" ],
                    "minimum" : 0,
                    "maximum" : 255
                },
                "high" : {
                    "description" : "DSCP range - high",
                    "type" : [ "integer", "null" ],
                    "minimum" : 0,
                    "maximum" : 255
                },
                "excepts" : {
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "integer",
                        "minimum" : 0,
                        "maximum" : 63
                    }
                }
            },
            "required" : [ "enable", "priority" ]
        }
    }
    
    
  • Response  204

Disable Qos Map Set 

/v2_1/rkszones/{zoneId}/wlans/{id}/qosMaps

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

  • Response  204

Modify Online Signup Service 

/v2_1/rkszones/{zoneId}/wlans/{id}/onlineSignupService

Use this API command to modify online signup service of a WLAN.

  • Request
  • Body
    {
        "zeroITOnboarding" : {
            "portal" : {
                "name" : "onlineSignupProfile"
            },
            "authServices" : [ {
                "name" : "globalAuth",
                "credentialType" : "LOCAL",
                "realm" : "realm.com",
                "expiration" : 123
            } ]
        },
        "onlineSignupEnabled" : true
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "zeroITOnboarding" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "portal" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        },
                        "description" : "Onboarding portal profile"
                    },
                    "authServices" : {
                        "description" : "Authentication services",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "id" : {
                                    "description" : "Identifier of authentication service",
                                    "type" : "string"
                                },
                                "name" : {
                                    "description" : "Authentication service name",
                                    "type" : "string"
                                },
                                "credentialType" : {
                                    "description" : "Provisioning credential type",
                                    "enum" : [ "LOCAL", "REMOTE" ]
                                },
                                "realm" : {
                                    "type" : "string",
                                    "maxLength" : 255,
                                    "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                    "description" : "Device provisioning realm"
                                },
                                "expiration" : {
                                    "description" : "Expiration hour. null mean never expire",
                                    "type" : [ "integer", "null" ],
                                    "minimum" : 1,
                                    "maximum" : 175200
                                }
                            },
                            "required" : [ "credentialType", "realm" ]
                        }
                    }
                },
                "required" : [ "portal", "authServices" ],
                "description" : "Zero-IT Onboarding"
            },
            "onlineSignupEnabled" : {
                "description" : "Hotspot 2.0 online signup enabled device registration from this guest portal",
                "type" : "boolean",
                "default" : false
            }
        },
        "description" : "Online signup service, only support for guest access WLAN"
    }
    
    
  • Response  204

Disable Zero-IT Onboarding 

/v2_1/rkszones/{zoneId}/wlans/{id}/onlineSignupService/zoroITOnboarding

Use this API command to disable Zero-IT onboarding of a WLAN.

  • Response  204

Delete 

/v2_1/rkszones/{zoneId}/wlans/{id}

Use this API command to delete a WLAN.

  • Response  204

WLAN Scheduler 

Retrieve List 

/v2_1/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", "null" ],
                            "maxLength" : 64,
                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                            "description" : "Description of the WLAN schedule"
                        },
                        "sun" : {
                            "description" : "Schedules on Sunday",
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        },
                        "mon" : {
                            "description" : "Schedules on Monday",
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        },
                        "tue" : {
                            "description" : "Schedules on Tuesday",
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        },
                        "wed" : {
                            "description" : "Schedules on Wednesday",
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        },
                        "thu" : {
                            "description" : "Schedules on Thursday",
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        },
                        "fri" : {
                            "description" : "Schedules on Friday",
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        },
                        "sat" : {
                            "description" : "Schedules on Saturday",
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve 

/v2_1/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", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN schedule"
            },
            "sun" : {
                "description" : "Schedules on Sunday",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "mon" : {
                "description" : "Schedules on Monday",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "tue" : {
                "description" : "Schedules on Tuesday",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "wed" : {
                "description" : "Schedules on Wednesday",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "thu" : {
                "description" : "Schedules on Thursday",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "fri" : {
                "description" : "Schedules on Friday",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "sat" : {
                "description" : "Schedules on Saturday",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            }
        }
    }
    
    

Create 

/v2_1/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", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the WLAN schedule"
            },
            "sun" : {
                "description" : "Schedules on Sunday",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "mon" : {
                "description" : "Schedules on Monday",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "tue" : {
                "description" : "Schedules on Tuesday",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "wed" : {
                "description" : "Schedules on Wednesday",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "thu" : {
                "description" : "Schedules on Thursday",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "fri" : {
                "description" : "Schedules on Friday",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "sat" : {
                "description" : "Schedules on Saturday",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            }
        },
        "required" : [ "name" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "wlanSchedulerUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the WLAN schedule",
                "type" : "string"
            }
        }
    }
    
    

Modify 

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

Delete 

/v2_1/rkszones/{zoneId}/wlanSchedulers/{id}

Use this API command to delete a WLAN schedule.

  • Response  204

Zone AAA 

Retrieve List - RADIUS 

/v2_1/rkszones/{zoneId}/aaa/radius

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

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "authenticationServerUUID",
            "mvnoId" : "userMVNOId",
            "zoneId" : "zoneUUID",
            "name" : "authenticationServerName",
            "description" : "authenticationServerDescription",
            "primary" : {
                "ip" : "192.168.1.1",
                "port" : 1812,
                "sharedSecret" : "sharedSecret"
            },
            "secondary" : {
                "ip" : "192.168.1.2",
                "port" : 1812,
                "sharedSecret" : "sharedSecret"
            }
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication server",
                            "type" : "string"
                        },
                        "zoneId" : {
                            "description" : "Identifier of the zone which the authentication server belongs to",
                            "type" : "string"
                        },
                        "mvnoId" : {
                            "description" : "Tenant UUID",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication server",
                            "type" : "string"
                        },
                        "description" : {
                            "description" : "Description of the authentication server",
                            "type" : "string"
                        },
                        "primary" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "ip" : {
                                    "type" : "string",
                                    "description" : "Server IP"
                                },
                                "port" : {
                                    "description" : "Server port",
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                },
                                "sharedSecret" : {
                                    "description" : "Server shared secrect",
                                    "type" : "string"
                                }
                            },
                            "required" : [ "ip", "port", "sharedSecret" ],
                            "description" : "Primary RADIUS server"
                        },
                        "secondary" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "ip" : {
                                    "type" : "string",
                                    "description" : "Server IP"
                                },
                                "port" : {
                                    "description" : "Server port",
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                },
                                "sharedSecret" : {
                                    "description" : "Server shared secrect",
                                    "type" : "string"
                                }
                            },
                            "required" : [ "ip", "port", "sharedSecret" ],
                            "description" : "Secondary RADIUS server"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve - RADIUS 

/v2_1/rkszones/{zoneId}/aaa/radius/{id}

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

  • Response  200
  • Body
    {
        "id" : "authenticationServerUUID",
        "mvnoId" : "userMVNOId",
        "zoneId" : "zoneUUID",
        "name" : "authenticationServerName",
        "description" : "authenticationServerDescription",
        "primary" : {
            "ip" : "192.168.1.1",
            "port" : 1812,
            "sharedSecret" : "sharedSecret"
        },
        "secondary" : {
            "ip" : "192.168.1.2",
            "port" : 1812,
            "sharedSecret" : "sharedSecret"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the authentication server",
                "type" : "string"
            },
            "zoneId" : {
                "description" : "Identifier of the zone which the authentication server belongs to",
                "type" : "string"
            },
            "mvnoId" : {
                "description" : "Tenant UUID",
                "type" : "string"
            },
            "name" : {
                "description" : "Name of the authentication server",
                "type" : "string"
            },
            "description" : {
                "description" : "Description of the authentication server",
                "type" : "string"
            },
            "primary" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "ip" : {
                        "type" : "string",
                        "description" : "Server IP"
                    },
                    "port" : {
                        "description" : "Server port",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 65535
                    },
                    "sharedSecret" : {
                        "description" : "Server shared secrect",
                        "type" : "string"
                    }
                },
                "required" : [ "ip", "port", "sharedSecret" ],
                "description" : "Primary RADIUS server"
            },
            "secondary" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "ip" : {
                        "type" : "string",
                        "description" : "Server IP"
                    },
                    "port" : {
                        "description" : "Server port",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 65535
                    },
                    "sharedSecret" : {
                        "description" : "Server shared secrect",
                        "type" : "string"
                    }
                },
                "required" : [ "ip", "port", "sharedSecret" ],
                "description" : "Secondary RADIUS server"
            }
        }
    }
    
    

Create - RADIUS 

/v2_1/rkszones/{zoneId}/aaa/radius

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

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

Modify - RADIUS 

/v2_1/rkszones/{zoneId}/aaa/radius/{id}

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

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

Modify - Primary Server of RADIUS 

/v2_1/rkszones/{zoneId}/aaa/radius/{id}/primary

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

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

Modify - Secondary Server of RADIUS 

/v2_1/rkszones/{zoneId}/aaa/radius/{id}/secondary

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

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

Disable Secondary Server - RADIUS 

/v2_1/rkszones/{zoneId}/aaa/radius/{id}/secondary

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

  • Response  204

Delete - RADIUS 

/v2_1/rkszones/{zoneId}/aaa/radius/{id}

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

  • Response  204

Retrieve List - RADIUS Accounting 

/v2_1/rkszones/{zoneId}/aaa/accounting

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

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "accountingServerUUID",
            "mvnoId" : "userMVNOId",
            "zoneId" : "zoneUUID",
            "name" : "accountingServerName",
            "description" : "accountingServerDescription",
            "primary" : {
                "ip" : "192.168.1.1",
                "port" : 1813,
                "sharedSecret" : "sharedSecret"
            },
            "secondary" : {
                "ip" : "192.168.1.2",
                "port" : 1813,
                "sharedSecret" : "sharedSecret"
            }
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the accounting server",
                            "type" : "string"
                        },
                        "zoneId" : {
                            "description" : "Identifier of the zone which the accounting server belongs to",
                            "type" : "string"
                        },
                        "mvnoId" : {
                            "description" : "Tenant UUID",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the accounting server",
                            "type" : "string"
                        },
                        "description" : {
                            "description" : "Description of the accounting server",
                            "type" : "string"
                        },
                        "primary" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "ip" : {
                                    "type" : "string",
                                    "description" : "Server IP"
                                },
                                "port" : {
                                    "description" : "Server port",
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                },
                                "sharedSecret" : {
                                    "description" : "Server shared secrect",
                                    "type" : "string"
                                }
                            },
                            "required" : [ "ip", "port", "sharedSecret" ],
                            "description" : "Primary RADIUS server"
                        },
                        "secondary" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "ip" : {
                                    "type" : "string",
                                    "description" : "Server IP"
                                },
                                "port" : {
                                    "description" : "Server port",
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                },
                                "sharedSecret" : {
                                    "description" : "Server shared secrect",
                                    "type" : "string"
                                }
                            },
                            "required" : [ "ip", "port", "sharedSecret" ],
                            "description" : "Secondary RADIUS server"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve - RADIUS Accounting 

/v2_1/rkszones/{zoneId}/aaa/accounting/{id}

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

  • Response  200
  • Body
    {
        "id" : "accountingServerUUID",
        "mvnoId" : "userMVNOId",
        "zoneId" : "zoneUUID",
        "name" : "accountingServerName",
        "description" : "accountingServerDescription",
        "primary" : {
            "ip" : "192.168.1.1",
            "port" : 1813,
            "sharedSecret" : "sharedSecret"
        },
        "secondary" : {
            "ip" : "192.168.1.2",
            "port" : 1813,
            "sharedSecret" : "sharedSecret"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the accounting server",
                "type" : "string"
            },
            "zoneId" : {
                "description" : "Identifier of the zone which the accounting server belongs to",
                "type" : "string"
            },
            "mvnoId" : {
                "description" : "Tenant UUID",
                "type" : "string"
            },
            "name" : {
                "description" : "Name of the accounting server",
                "type" : "string"
            },
            "description" : {
                "description" : "Description of the accounting server",
                "type" : "string"
            },
            "primary" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "ip" : {
                        "type" : "string",
                        "description" : "Server IP"
                    },
                    "port" : {
                        "description" : "Server port",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 65535
                    },
                    "sharedSecret" : {
                        "description" : "Server shared secrect",
                        "type" : "string"
                    }
                },
                "required" : [ "ip", "port", "sharedSecret" ],
                "description" : "Primary RADIUS server"
            },
            "secondary" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "ip" : {
                        "type" : "string",
                        "description" : "Server IP"
                    },
                    "port" : {
                        "description" : "Server port",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 65535
                    },
                    "sharedSecret" : {
                        "description" : "Server shared secrect",
                        "type" : "string"
                    }
                },
                "required" : [ "ip", "port", "sharedSecret" ],
                "description" : "Secondary RADIUS server"
            }
        }
    }
    
    

Create - RADIUS Accounting 

/v2_1/rkszones/{zoneId}/aaa/accounting

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

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

Modify - RADIUS Accounting 

/v2_1/rkszones/{zoneId}/aaa/accounting/{id}

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

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

Modify - Primary Server of RADIUS Accounting 

/v2_1/rkszones/{zoneId}/aaa/accounting/{id}/primary

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

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

Modify - Secondary Server of RADIUS Accounting 

/v2_1/rkszones/{zoneId}/aaa/accounting/{id}/secondary

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

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

Disable Secondary Server - RADIUS Accounting 

/v2_1/rkszones/{zoneId}/aaa/accounting/{id}/secondary

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

  • Response  204

Delete - RADIUS Accounting 

/v2_1/rkszones/{zoneId}/aaa/accounting/{id}

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

  • Response  204

Retrieve List - ActiveDirectory 

/v2_1/rkszones/{zoneId}/aaa/ad

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

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "a49bf7dd-be4a-45fb-abd6-bc15dcd697c2",
            "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
            "zoneId" : "3c7fd7f4-68bd-4957-a698-a1a810888959",
            "name" : "activeDirectoryServerName",
            "description" : null,
            "ip" : "192.168.1.1",
            "port" : 389,
            "windowsDomainName" : null,
            "adminDomainName" : null,
            "password" : "",
            "globalCatalogEnabled" : false
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the active directory server",
                            "type" : "string"
                        },
                        "zoneId" : {
                            "description" : "Identifier of the zone which the active directory server belongs to",
                            "type" : "string"
                        },
                        "mvnoId" : {
                            "description" : "Tenant UUID",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the active directory server",
                            "type" : "string"
                        },
                        "description" : {
                            "description" : "Description of the active directory server",
                            "type" : "string"
                        },
                        "ip" : {
                            "description" : "IP address",
                            "type" : "string"
                        },
                        "port" : {
                            "description" : "Port",
                            "type" : "integer"
                        },
                        "windowsDomainName" : {
                            "description" : "Windows domain name",
                            "type" : "string"
                        },
                        "adminDomainName" : {
                            "description" : "Admin domain name",
                            "type" : "string"
                        },
                        "password" : {
                            "description" : "Admin password",
                            "type" : "string"
                        },
                        "globalCatalogEnabled" : {
                            "description" : "Enable global catalog support",
                            "type" : "boolean"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve - ActiveDirectory 

/v2_1/rkszones/{zoneId}/aaa/ad/{id}

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

  • Response  200
  • Body
    {
        "id" : "a49bf7dd-be4a-45fb-abd6-bc15dcd697c2",
        "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
        "zoneId" : "3c7fd7f4-68bd-4957-a698-a1a810888959",
        "name" : "activeDirectoryServerName",
        "description" : null,
        "ip" : "192.168.1.1",
        "port" : 389,
        "windowsDomainName" : null,
        "adminDomainName" : null,
        "password" : "",
        "globalCatalogEnabled" : false
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the active directory server",
                "type" : "string"
            },
            "zoneId" : {
                "description" : "Identifier of the zone which the active directory server belongs to",
                "type" : "string"
            },
            "mvnoId" : {
                "description" : "Tenant UUID",
                "type" : "string"
            },
            "name" : {
                "description" : "Name of the active directory server",
                "type" : "string"
            },
            "description" : {
                "description" : "Description of the active directory server",
                "type" : "string"
            },
            "ip" : {
                "description" : "IP address",
                "type" : "string"
            },
            "port" : {
                "description" : "Port",
                "type" : "integer"
            },
            "windowsDomainName" : {
                "description" : "Windows domain name",
                "type" : "string"
            },
            "adminDomainName" : {
                "description" : "Admin domain name",
                "type" : "string"
            },
            "password" : {
                "description" : "Admin password",
                "type" : "string"
            },
            "globalCatalogEnabled" : {
                "description" : "Enable global catalog support",
                "type" : "boolean"
            }
        }
    }
    
    

Create - ActiveDirectory 

/v2_1/rkszones/{zoneId}/aaa/ad

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

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

Modify - ActiveDirectory 

/v2_1/rkszones/{zoneId}/aaa/ad/{id}

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

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

Delete - ActiveDirectory 

/v2_1/rkszones/{zoneId}/aaa/ad/{id}

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

  • Response  204

Retrieve List - LDAP 

/v2_1/rkszones/{zoneId}/aaa/ldap

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

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "32fb8816-60e7-46df-876b-038c655278d4",
            "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
            "zoneId" : "3c7fd7f4-68bd-4957-a698-a1a810888959",
            "name" : "rapheal-ldap",
            "description" : "",
            "ip" : "1.1.1.1",
            "port" : 389,
            "baseDomainName" : "dc=ldap",
            "adminDomainName" : "ibm",
            "password" : "admin",
            "keyAttribute" : "uid",
            "searchFilter" : "objectClass=*"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the LDAP server",
                            "type" : "string"
                        },
                        "zoneId" : {
                            "description" : "Identifier of the zone which the LDAP server belongs to",
                            "type" : "string"
                        },
                        "mvnoId" : {
                            "description" : "Tenant UUID",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the LDAP server",
                            "type" : "string"
                        },
                        "description" : {
                            "description" : "Description of the LDAP server",
                            "type" : "string"
                        },
                        "ip" : {
                            "description" : "IP address",
                            "type" : "string"
                        },
                        "port" : {
                            "description" : "Port",
                            "type" : "integer"
                        },
                        "baseDomainName" : {
                            "description" : "Base domain name",
                            "type" : "string"
                        },
                        "adminDomainName" : {
                            "description" : "Admin domain name",
                            "type" : "string"
                        },
                        "password" : {
                            "description" : "Admin password",
                            "type" : "string"
                        },
                        "keyAttribute" : {
                            "description" : "Key attribute",
                            "type" : "string"
                        },
                        "searchFilter" : {
                            "description" : "Search filter",
                            "type" : "string"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve - LDAP 

/v2_1/rkszones/{zoneId}/aaa/ldap/{id}

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

  • Response  200
  • Body
    {
        "id" : "32fb8816-60e7-46df-876b-038c655278d4",
        "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
        "zoneId" : "3c7fd7f4-68bd-4957-a698-a1a810888959",
        "name" : "rapheal-ldap",
        "description" : "",
        "ip" : "1.1.1.1",
        "port" : 389,
        "baseDomainName" : "dc=ldap",
        "adminDomainName" : "ibm",
        "password" : "admin",
        "keyAttribute" : "uid",
        "searchFilter" : "objectClass=*"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the LDAP server",
                "type" : "string"
            },
            "zoneId" : {
                "description" : "Identifier of the zone which the LDAP server belongs to",
                "type" : "string"
            },
            "mvnoId" : {
                "description" : "Tenant UUID",
                "type" : "string"
            },
            "name" : {
                "description" : "Name of the LDAP server",
                "type" : "string"
            },
            "description" : {
                "description" : "Description of the LDAP server",
                "type" : "string"
            },
            "ip" : {
                "description" : "IP address",
                "type" : "string"
            },
            "port" : {
                "description" : "Port",
                "type" : "integer"
            },
            "baseDomainName" : {
                "description" : "Base domain name",
                "type" : "string"
            },
            "adminDomainName" : {
                "description" : "Admin domain name",
                "type" : "string"
            },
            "password" : {
                "description" : "Admin password",
                "type" : "string"
            },
            "keyAttribute" : {
                "description" : "Key attribute",
                "type" : "string"
            },
            "searchFilter" : {
                "description" : "Search filter",
                "type" : "string"
            }
        }
    }
    
    

Create - LDAP 

/v2_1/rkszones/{zoneId}/aaa/ldap

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

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

Modify - LDAP 

/v2_1/rkszones/{zoneId}/aaa/ldap/{id}

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

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

Delete - LDAP 

/v2_1/rkszones/{zoneId}/aaa/ldap/{id}

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

  • Response  204

Web Authentication 

Retrieve List 

/v2_1/rkszones/{zoneId}/portals/webauth

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

  • Response  200
  • Body
    {
        "totalCount" : 9,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "c5dfc930-75dc-11e4-8d56-00606eb0c700",
            "name" : "protalName1"
        }, {
            "id" : "15efd160-7153-11e4-aa08-00606eb0c700",
            "name" : "protalName2"
        }, {
            "id" : "be0f0480-73a9-11e4-9d1d-f0def13d5845",
            "name" : "protalName3"
        }, {
            "id" : "7f0eef00-7423-11e4-bcef-000c299b4765",
            "name" : "protalName4"
        }, {
            "id" : "4f5c98a0-7123-11e4-bcef-000c299b4765",
            "name" : "protalName5"
        }, {
            "id" : "4a023ce0-73ab-11e4-b211-f0def13d5845",
            "name" : "protalName6"
        }, {
            "id" : "afebbc80-73be-11e4-bfde-f0def13d5845",
            "name" : "protalName7"
        }, {
            "id" : "76f4c020-7620-11e4-b8b9-00606eb0c700",
            "name" : "protalName8"
        }, {
            "id" : "96308310-752c-11e4-8276-00606eb0c700",
            "name" : "protalName9"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the service",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the service"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve 

/v2_1/rkszones/{zoneId}/portals/webauth/{id}

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

  • Response  200
  • Body
    {
        "name" : "Web Authentication Modify",
        "id" : "3e769bc0-7ead-11e4-9517-00606eb0c700",
        "description" : "Web Authentication Modify Description",
        "portalLanguage" : "en_US",
        "redirect" : {
            "url" : "https://www.ruckuswireless.com"
        },
        "userSession" : {
            "timeoutInMin" : 180,
            "gracePeriodInMin" : 120
        },
        "zoneId" : "b4187899-38ae-4ace-8e40-0bc444455156"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the web authentication profile",
                "type" : "string"
            },
            "zoneId" : {
                "description" : "Identifier of the zone which the web authentication profile belongs to",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the web authentication profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the web authentication profile"
            },
            "portalLanguage" : {
                "description" : "Portal language of the web authentication profile",
                "default" : "en_US",
                "enum" : [ "en_US", "zh_TW", "zh_CN", "nl_NL", "fr_FR", "de_DE", "ja_JP", "es_ES", "se_SE", "ar_SA", "cz_CZ", "da_DK", "tr_TR", "pt_BR" ]
            },
            "redirect" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "url" : {
                        "type" : "string",
                        "description" : "Portal redirect URL"
                    }
                },
                "description" : "Redirect configuration of the web authentication profile"
            },
            "userSession" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "timeoutInMin" : {
                        "description" : "Time out value in minutes",
                        "type" : "integer",
                        "default" : 1440,
                        "minimum" : 2,
                        "maximum" : 14400
                    },
                    "gracePeriodInMin" : {
                        "description" : "Grace period in minutes",
                        "type" : "integer",
                        "default" : 60,
                        "minimum" : 1,
                        "maximum" : 14399
                    }
                },
                "description" : "User session of the web authentication profile"
            }
        }
    }
    
    

Create 

/v2_1/rkszones/{zoneId}/portals/webauth

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

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

Modify Basic 

/v2_1/rkszones/{zoneId}/portals/webauth/{id}

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

  • Request
  • Body
    {
        "name" : "Web Authentication Modify",
        "description" : "Web Authentication Modify Description",
        "portalLanguage" : "en_US"
    }
    
    
    Schema
    {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the web authentication profile"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the web authentication profile"
        },
        "portalLanguage" : {
            "description" : "Portal language of the web authentication profile",
            "default" : "en_US",
            "enum" : [ "en_US", "zh_TW", "zh_CN", "nl_NL", "fr_FR", "de_DE", "ja_JP", "es_ES", "se_SE", "ar_SA", "cz_CZ", "da_DK", "tr_TR", "pt_BR" ]
        }
    }
    
    
  • Response  204

Modify Redirect 

/v2_1/rkszones/{zoneId}/portals/webauth/{id}/redirect

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

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

Redirect to URL user visit 

/v2_1/rkszones/{zoneId}/portals/webauth/{id}/redirect

Use this API command to set redirect to the URL that user intends to visit on web authentication of a zone.

  • Response  204

Delete 

/v2_1/rkszones/{zoneId}/portals/webauth/{id}

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

  • Response  204

Guest Access 

Retrieve List 

/v2_1/rkszones/{zoneId}/portals/guest

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

  • Response  200
  • Body
    {
        "totalCount" : 9,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "c5dfc930-75dc-11e4-8d56-00606eb0c700",
            "name" : "protalName1"
        }, {
            "id" : "15efd160-7153-11e4-aa08-00606eb0c700",
            "name" : "protalName2"
        }, {
            "id" : "be0f0480-73a9-11e4-9d1d-f0def13d5845",
            "name" : "protalName3"
        }, {
            "id" : "7f0eef00-7423-11e4-bcef-000c299b4765",
            "name" : "protalName4"
        }, {
            "id" : "4f5c98a0-7123-11e4-bcef-000c299b4765",
            "name" : "protalName5"
        }, {
            "id" : "4a023ce0-73ab-11e4-b211-f0def13d5845",
            "name" : "protalName6"
        }, {
            "id" : "afebbc80-73be-11e4-bfde-f0def13d5845",
            "name" : "protalName7"
        }, {
            "id" : "76f4c020-7620-11e4-b8b9-00606eb0c700",
            "name" : "protalName8"
        }, {
            "id" : "96308310-752c-11e4-8276-00606eb0c700",
            "name" : "protalName9"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the service",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the service"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve 

/v2_1/rkszones/{zoneId}/portals/guest/{id}

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

  • Response  200
  • Body
    {
        "id" : "15efd160-7153-11e4-aa08-00606eb0c700",
        "zoneId" : "d664f517-cdc5-4997-8248-980a0b7a0542",
        "name" : "GuestAccessSmart",
        "description" : "basic configuration test",
        "portalCustomization" : {
            "language" : "en_US",
            "title" : "Welcome to the Guest Access login page.",
            "logo" : "logo description",
            "termsAndConditionsText" : "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
            "termsAndConditionsRequired" : true
        },
        "redirect" : {
            "url" : "http://www.google.com"
        },
        "smsGateway" : null,
        "userSession" : {
            "timeoutInMin" : 180,
            "gracePeriodInMin" : 120
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the guest access profile",
                "type" : "string"
            },
            "zoneId" : {
                "description" : "Identifier of the zone which the guest access profile belongs to",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the guest access profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the guest access profile"
            },
            "portalCustomization" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "language" : {
                        "description" : "Language",
                        "default" : "en_US",
                        "enum" : [ "en_US", "zh_TW", "zh_CN", "nl_NL", "fr_FR", "de_DE", "ja_JP", "es_ES", "se_SE", "ar_SA", "cz_CZ", "da_DK", "tr_TR", "pt_BR" ]
                    },
                    "title" : {
                        "description" : "Title",
                        "type" : "string",
                        "minLength" : 0,
                        "maxLength" : 63
                    },
                    "logo" : {
                        "description" : "logo",
                        "type" : "string"
                    },
                    "termsAndConditionsRequired" : {
                        "description" : "Terms and conditions is required or not",
                        "type" : "boolean",
                        "default" : "false"
                    },
                    "termsAndConditionsText" : {
                        "description" : "Terms and conditions text",
                        "type" : "string",
                        "default" : "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
                        "minLength" : 0,
                        "maxLength" : 3999
                    }
                },
                "required" : [ "language" ],
                "description" : "Portal customization of the guest access profile"
            },
            "redirect" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "url" : {
                        "type" : "string",
                        "description" : "Portal redirect URL"
                    }
                },
                "description" : "Redirect configuration of the guest access profile"
            },
            "smsGateway" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Portal SMS gateway of the guest access profile"
            },
            "userSession" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "timeoutInMin" : {
                        "description" : "Time out value in minutes",
                        "type" : "integer",
                        "default" : 1440,
                        "minimum" : 2,
                        "maximum" : 14400
                    },
                    "gracePeriodInMin" : {
                        "description" : "Grace period in minutes",
                        "type" : "integer",
                        "default" : 60,
                        "minimum" : 1,
                        "maximum" : 14399
                    }
                },
                "description" : "User session of the guest access profile"
            }
        }
    }
    
    

Create 

/v2_1/rkszones/{zoneId}/portals/guest

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

  • Request
  • Body
    {
        "name" : "GuestAccess test",
        "description" : "guest access test description",
        "portalCustomization" : {
            "language" : "en_US",
            "title" : "Welcome to the Guest Access login page.",
            "logo" : "test",
            "termsAndConditionsRequired" : true,
            "termsAndConditionsText" : "test"
        },
        "redirect" : {
            "url" : "http://www.ruckuswireless.com"
        },
        "smsGateway" : {
            "name" : "defaultServer"
        },
        "userSession" : {
            "timeoutInMin" : 180,
            "gracePeriodInMin" : 120
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the guest access profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the guest access profile"
            },
            "portalCustomization" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "language" : {
                        "description" : "Language",
                        "default" : "en_US",
                        "enum" : [ "en_US", "zh_TW", "zh_CN", "nl_NL", "fr_FR", "de_DE", "ja_JP", "es_ES", "se_SE", "ar_SA", "cz_CZ", "da_DK", "tr_TR", "pt_BR" ]
                    },
                    "title" : {
                        "description" : "Title",
                        "type" : "string",
                        "minLength" : 0,
                        "maxLength" : 63
                    },
                    "logo" : {
                        "description" : "logo",
                        "type" : "string"
                    },
                    "termsAndConditionsRequired" : {
                        "description" : "Terms and conditions is required or not",
                        "type" : "boolean",
                        "default" : "false"
                    },
                    "termsAndConditionsText" : {
                        "description" : "Terms and conditions text",
                        "type" : "string",
                        "default" : "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
                        "minLength" : 0,
                        "maxLength" : 3999
                    }
                },
                "required" : [ "language" ],
                "description" : "Portal customization of the guest access profile"
            },
            "redirect" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "url" : {
                        "type" : "string",
                        "description" : "Portal redirect URL"
                    }
                },
                "description" : "Redirect configuration of the guest access profile"
            },
            "smsGateway" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Portal SMS gateway of the guest access profile"
            },
            "userSession" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "timeoutInMin" : {
                        "description" : "Time out value in minutes",
                        "type" : "integer",
                        "default" : 1440,
                        "minimum" : 2,
                        "maximum" : 14400
                    },
                    "gracePeriodInMin" : {
                        "description" : "Grace period in minutes",
                        "type" : "integer",
                        "default" : 60,
                        "minimum" : 1,
                        "maximum" : 14399
                    }
                },
                "description" : "Redirect configuration of the guest access profile"
            }
        },
        "required" : [ "name", "portalCustomization", "userSession" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the created portal profile",
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v2_1/rkszones/{zoneId}/portals/guest/{id}

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

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

Modify redirect 

/v2_1/rkszones/{zoneId}/portals/guest/{id}/redirect

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

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

Redirect to URL user visit 

/v2_1/rkszones/{zoneId}/portals/guest/{id}/redirect

Use this API command to set redirect to the URL that user intends to visit on guest access of a zone.

  • Response  204

Modify SMS Gateway 

/v2_1/rkszones/{zoneId}/portals/guest/{id}/smsGateway

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

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

Disable SMS Gateway 

/v2_1/rkszones/{zoneId}/portals/guest/{id}/smsGateway

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

  • Response  204

Modify Portal Customization 

/v2_1/rkszones/{zoneId}/portals/guest/{id}/portalCustomization

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

  • Request
  • Body
    {
        "language" : "zh_TW",
        "title" : "Welcome to the Guest Access login page.",
        "logo" : "logo description",
        "termsAndConditionsRequired" : true,
        "termsAndConditionsText" : "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless."
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "language" : {
                "description" : "Language",
                "default" : "en_US",
                "enum" : [ "en_US", "zh_TW", "zh_CN", "nl_NL", "fr_FR", "de_DE", "ja_JP", "es_ES", "se_SE", "ar_SA", "cz_CZ", "da_DK", "tr_TR", "pt_BR" ]
            },
            "title" : {
                "description" : "Title",
                "type" : "string",
                "minLength" : 0,
                "maxLength" : 63
            },
            "logo" : {
                "description" : "logo",
                "type" : "string"
            },
            "termsAndConditionsRequired" : {
                "description" : "Terms and conditions is required or not",
                "type" : "boolean",
                "default" : "false"
            },
            "termsAndConditionsText" : {
                "description" : "Terms and conditions text",
                "type" : "string",
                "default" : "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
                "minLength" : 0,
                "maxLength" : 3999
            }
        },
        "required" : [ "language" ],
        "description" : "Portal customization of the guest access profile"
    }
    
    
  • Response  204

Modify User Session 

/v2_1/rkszones/{zoneId}/portals/guest/{id}/userSession

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

  • Request
  • Body
    {
        "timeoutInMin" : 180,
        "gracePeriodInMin" : 60
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "timeoutInMin" : {
                "description" : "Time out value in minutes",
                "type" : "integer",
                "default" : 1440,
                "minimum" : 2,
                "maximum" : 14400
            },
            "gracePeriodInMin" : {
                "description" : "Grace period in minutes",
                "type" : "integer",
                "default" : 60,
                "minimum" : 1,
                "maximum" : 14399
            }
        },
        "description" : "User session of the guest access profile"
    }
    
    
  • Response  204

Delete 

/v2_1/rkszones/{zoneId}/portals/guest/{id}

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

  • Response  204

User Traffic Profile 

Retrieve List - User Traffic Profile 

/v2_1/profiles/utp

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

  • 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" : [ {
            "id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
            "name" : "new name"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the profile",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the profile"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve - User Traffic Profile 

/v2_1/profiles/utp/{id}

Use this API command to retrieve an user traffic profile

  • Response  200
  • Body
    {
        "id" : "1869c000-9c5e-11e4-9d3a-00606eb0c700",
        "name" : "user-traffic-profile-name",
        "description" : "user traffic profile description",
        "defaultAction" : "ALLOW",
        "ipAclRules" : [ {
            "priority" : 1,
            "description" : "Allow DNS",
            "enableSourceIpSubnet" : true,
            "sourceIp" : "172.17.26.50",
            "sourceIpMask" : "255.255.0.0",
            "enableDestinationIpSubnet" : true,
            "destinationIp" : "172.17.29.31",
            "destinationIpMask" : "255.255.255.0",
            "enableSourcePortRange" : true,
            "sourceMinPort" : 10,
            "sourceMaxPort" : 65530,
            "enableDestinationPortRange" : false,
            "destinationMinPort" : 53,
            "destinationMaxPort" : null,
            "protocol" : null,
            "action" : "ALLOW",
            "direction" : "UPSTREAM"
        }, {
            "priority" : 2,
            "description" : "Allow DHCP",
            "enableSourceIpSubnet" : false,
            "sourceIp" : "172.17.51.99",
            "sourceIpMask" : "",
            "enableDestinationIpSubnet" : false,
            "destinationIp" : "172.17.53.99",
            "destinationIpMask" : "",
            "enableSourcePortRange" : true,
            "sourceMinPort" : null,
            "sourceMaxPort" : null,
            "enableDestinationPortRange" : false,
            "destinationMinPort" : 67,
            "destinationMaxPort" : null,
            "protocol" : null,
            "action" : "ALLOW",
            "direction" : "UPSTREAM"
        } ],
        "uplinkRateLimiting" : {
            "uplinkRateLimitingEnabled" : true,
            "uplinkRateLimitingBps" : "2.75 mbps"
        },
        "downlinkRateLimiting" : {
            "downlinkRateLimitingEnabled" : true,
            "downlinkRateLimitingBps" : "2.00 mbps"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the user traffic profile",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the user traffic profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the user traffic profile"
            },
            "defaultAction" : {
                "description" : "Default action",
                "default" : "ALLOW",
                "enum" : [ "BLOCK", "ALLOW" ]
            },
            "uplinkRateLimiting" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "uplinkRateLimitingEnabled" : {
                        "description" : "Uplink rate limiting enabled or disabled",
                        "type" : "boolean",
                        "default" : false
                    },
                    "uplinkRateLimitingBps" : {
                        "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"
                    }
                },
                "description" : "Uplink rate limiting"
            },
            "downlinkRateLimiting" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "downlinkRateLimitingEnabled" : {
                        "description" : "Downlink rate limiting enabled or disabled",
                        "type" : "boolean",
                        "default" : false
                    },
                    "downlinkRateLimitingBps" : {
                        "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" : "Downlink rate limiting"
                    }
                },
                "description" : "Downlink rate limiting"
            },
            "ipAclRules" : {
                "type" : "array",
                "description" : "Traffic access control list",
                "items" : {
                    "type" : "object",
                    "description" : "Traffic access control list",
                    "additionalProperties" : false,
                    "properties" : {
                        "priority" : {
                            "type" : "integer",
                            "description" : "Priority"
                        },
                        "description" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 64,
                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                            "description" : "Description of the traffic access control rule"
                        },
                        "enableSourceIpSubnet" : {
                            "description" : "Source IP subnet enabled or disabled",
                            "type" : "boolean"
                        },
                        "sourceIp" : {
                            "type" : "string",
                            "description" : "Subnet network address or ip address of source IP."
                        },
                        "sourceIpMask" : {
                            "type" : "string",
                            "description" : "Subnet mask of source IP"
                        },
                        "enableDestinationIpSubnet" : {
                            "description" : "Destination IP subnet enabled or disabled",
                            "type" : "boolean"
                        },
                        "destinationIp" : {
                            "type" : "string",
                            "description" : "Subnet network address or ip address of destination IP."
                        },
                        "destinationIpMask" : {
                            "type" : "string",
                            "description" : "Subnet mask of destination IP"
                        },
                        "enableSourcePortRange" : {
                            "description" : "Source port range enabled or disabled",
                            "type" : "boolean"
                        },
                        "sourceMinPort" : {
                            "type" : "integer",
                            "description" : "The minunum port of source port range."
                        },
                        "sourceMaxPort" : {
                            "type" : "integer",
                            "description" : "The maxinum port of source port range."
                        },
                        "enableDestinationPortRange" : {
                            "description" : "Destincation port range enabled or disabled",
                            "type" : "boolean"
                        },
                        "destinationMinPort" : {
                            "type" : "integer",
                            "description" : "The mininum port of destination port range."
                        },
                        "destinationMaxPort" : {
                            "type" : "integer",
                            "description" : "The maxinum port of destination port range."
                        },
                        "protocol" : {
                            "description" : "The protocol of traffic access control.",
                            "enum" : [ "TCP", "UDP", "UDPLITE", "ICMP_ICMPV4", "ICMPV6", "IGMP", "ESP", "AH", "SCTP" ]
                        },
                        "action" : {
                            "description" : "The access of traffic access control.",
                            "default" : "ALLOW",
                            "enum" : [ "ALLOW", "BLOCK" ]
                        },
                        "direction" : {
                            "description" : "The direction of traffic access control.",
                            "default" : "UPSTREAM",
                            "enum" : [ "UPSTREAM" ]
                        }
                    },
                    "required" : [ "action", "direction" ]
                }
            }
        }
    }
    
    

Create - User Traffic Profile 

/v2_1/profiles/utp

Use this API command to create a new user traffic profile

  • Request
  • Body
    {
        "name" : "user-traffic-profile-name",
        "description" : "User traffic profile description",
        "defaultAction" : "ALLOW",
        "uplinkRateLimiting" : {
            "uplinkRateLimitingEnabled" : true,
            "uplinkRateLimitingBps" : "2.75 mbps"
        },
        "downlinkRateLimiting" : {
            "downlinkRateLimitingEnabled" : true,
            "downlinkRateLimitingBps" : "2.00 mbps"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the user traffic profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the user traffic profile"
            },
            "defaultAction" : {
                "description" : "Default action",
                "default" : "ALLOW",
                "enum" : [ "BLOCK", "ALLOW" ]
            },
            "uplinkRateLimiting" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "uplinkRateLimitingEnabled" : {
                        "description" : "Uplink rate limiting enabled or disabled",
                        "type" : "boolean",
                        "default" : false
                    },
                    "uplinkRateLimitingBps" : {
                        "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"
                    }
                },
                "description" : "Uplink rate limiting"
            },
            "downlinkRateLimiting" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "downlinkRateLimitingEnabled" : {
                        "description" : "Downlink rate limiting enabled or disabled",
                        "type" : "boolean",
                        "default" : false
                    },
                    "downlinkRateLimitingBps" : {
                        "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" : "Downlink rate limiting"
                    }
                },
                "description" : "Downlink rate limiting"
            },
            "ipAclRules" : {
                "type" : "array",
                "description" : "Traffic access control list",
                "items" : {
                    "type" : "object",
                    "description" : "Traffic access control list",
                    "additionalProperties" : false,
                    "properties" : {
                        "priority" : {
                            "type" : "integer",
                            "description" : "Priority"
                        },
                        "description" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 64,
                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                            "description" : "Description of the traffic access control rule"
                        },
                        "enableSourceIpSubnet" : {
                            "description" : "Source IP subnet enabled or disabled",
                            "type" : "boolean"
                        },
                        "sourceIp" : {
                            "type" : "string",
                            "description" : "Subnet network address or ip address of source IP."
                        },
                        "sourceIpMask" : {
                            "type" : "string",
                            "description" : "Subnet mask of source IP"
                        },
                        "enableDestinationIpSubnet" : {
                            "description" : "Destination IP subnet enabled or disabled",
                            "type" : "boolean"
                        },
                        "destinationIp" : {
                            "type" : "string",
                            "description" : "Subnet network address or ip address of destination IP."
                        },
                        "destinationIpMask" : {
                            "type" : "string",
                            "description" : "Subnet mask of destination IP"
                        },
                        "enableSourcePortRange" : {
                            "description" : "Source port range enabled or disabled",
                            "type" : "boolean"
                        },
                        "sourceMinPort" : {
                            "type" : "integer",
                            "description" : "The minunum port of source port range."
                        },
                        "sourceMaxPort" : {
                            "type" : "integer",
                            "description" : "The maxinum port of source port range."
                        },
                        "enableDestinationPortRange" : {
                            "description" : "Destincation port range enabled or disabled",
                            "type" : "boolean"
                        },
                        "destinationMinPort" : {
                            "type" : "integer",
                            "description" : "The mininum port of destination port range."
                        },
                        "destinationMaxPort" : {
                            "type" : "integer",
                            "description" : "The maxinum port of destination port range."
                        },
                        "protocol" : {
                            "description" : "The protocol of traffic access control.",
                            "enum" : [ "TCP", "UDP", "UDPLITE", "ICMP_ICMPV4", "ICMPV6", "IGMP", "ESP", "AH", "SCTP" ]
                        },
                        "action" : {
                            "description" : "The access of traffic access control.",
                            "default" : "ALLOW",
                            "enum" : [ "ALLOW", "BLOCK" ]
                        },
                        "direction" : {
                            "description" : "The direction of traffic access control.",
                            "default" : "UPSTREAM",
                            "enum" : [ "UPSTREAM" ]
                        }
                    },
                    "required" : [ "action", "direction" ]
                }
            }
        },
        "required" : [ "name", "defaultAction" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "profileUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Modify - User Traffic Profile 

/v2_1/profiles/utp/{id}

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

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

Modify - IpAclRules 

/v2_1/profiles/utp/{id}/ipAclRules

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

  • Request
  • Body
    [ {
        "priority" : 3,
        "description" : "acl rule description",
        "enableSourceIpSubnet" : true,
        "sourceIp" : "172.17.26.55",
        "sourceIpMask" : "255.255.255.0",
        "enableSourcePortRange" : false,
        "sourceMinPort" : 101,
        "enableDestinationPortRange" : false,
        "destinationIp" : "172.17.26.60",
        "destinationIpMask" : "255.255.0.0",
        "protocol" : "TCP",
        "action" : "ALLOW",
        "direction" : "UPSTREAM"
    }, {
        "priority" : 4,
        "description" : "acl rule description",
        "enableSourceIpSubnet" : true,
        "sourceIp" : "255.17.26.87",
        "sourceIpMask" : "255.255.255.0",
        "destinationIp" : "172.17.26.69",
        "destinationIpMask" : "255.255.0.0",
        "protocol" : "UDP",
        "action" : "BLOCK",
        "direction" : "UPSTREAM"
    } ]
    
    
    Schema
    {
        "type" : "array",
        "description" : "Traffic access control list",
        "items" : {
            "type" : "object",
            "description" : "Traffic access control list",
            "additionalProperties" : false,
            "properties" : {
                "priority" : {
                    "type" : "integer",
                    "description" : "Priority"
                },
                "description" : {
                    "type" : [ "string", "null" ],
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "description" : "Description of the traffic access control rule"
                },
                "enableSourceIpSubnet" : {
                    "description" : "Source IP subnet enabled or disabled",
                    "type" : "boolean"
                },
                "sourceIp" : {
                    "type" : "string",
                    "description" : "Subnet network address or ip address of source IP."
                },
                "sourceIpMask" : {
                    "type" : "string",
                    "description" : "Subnet mask of source IP"
                },
                "enableDestinationIpSubnet" : {
                    "description" : "Destination IP subnet enabled or disabled",
                    "type" : "boolean"
                },
                "destinationIp" : {
                    "type" : "string",
                    "description" : "Subnet network address or ip address of destination IP."
                },
                "destinationIpMask" : {
                    "type" : "string",
                    "description" : "Subnet mask of destination IP"
                },
                "enableSourcePortRange" : {
                    "description" : "Source port range enabled or disabled",
                    "type" : "boolean"
                },
                "sourceMinPort" : {
                    "type" : "integer",
                    "description" : "The minunum port of source port range."
                },
                "sourceMaxPort" : {
                    "type" : "integer",
                    "description" : "The maxinum port of source port range."
                },
                "enableDestinationPortRange" : {
                    "description" : "Destincation port range enabled or disabled",
                    "type" : "boolean"
                },
                "destinationMinPort" : {
                    "type" : "integer",
                    "description" : "The mininum port of destination port range."
                },
                "destinationMaxPort" : {
                    "type" : "integer",
                    "description" : "The maxinum port of destination port range."
                },
                "protocol" : {
                    "description" : "The protocol of traffic access control.",
                    "enum" : [ "TCP", "UDP", "UDPLITE", "ICMP_ICMPV4", "ICMPV6", "IGMP", "ESP", "AH", "SCTP" ]
                },
                "action" : {
                    "description" : "The access of traffic access control.",
                    "default" : "ALLOW",
                    "enum" : [ "ALLOW", "BLOCK" ]
                },
                "direction" : {
                    "description" : "The direction of traffic access control.",
                    "default" : "UPSTREAM",
                    "enum" : [ "UPSTREAM" ]
                }
            },
            "required" : [ "action", "direction" ]
        }
    }
    
    
  • Response  204

Modify - uplinkRateLimiting 

/v2_1/profiles/utp/{id}/uplinkRateLimiting

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

  • Request
  • Body
    {
        "uplinkRateLimitingEnabled" : true,
        "uplinkRateLimitingBps" : "0.10 mbps"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "uplinkRateLimitingEnabled" : {
                "description" : "Uplink rate limiting enabled or disabled",
                "type" : "boolean",
                "default" : false
            },
            "uplinkRateLimitingBps" : {
                "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"
            }
        },
        "description" : "Uplink rate limiting"
    }
    
    
  • Response  204

Disable - uplinkRateLimiting 

/v2_1/profiles/utp/{id}/uplinkRateLimiting

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

  • Response  204

Modify - downlinkRateLimiting 

/v2_1/profiles/utp/{id}/downlinkRateLimiting

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

  • Request
  • Body
    {
        "downlinkRateLimitingEnabled" : true,
        "downlinkRateLimitingBps" : "0.10 mbps"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "downlinkRateLimitingEnabled" : {
                "description" : "Downlink rate limiting enabled or disabled",
                "type" : "boolean",
                "default" : false
            },
            "downlinkRateLimitingBps" : {
                "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" : "Downlink rate limiting"
            }
        },
        "description" : "Downlink rate limiting"
    }
    
    
  • Response  204

Disable - downlinkRateLimiting 

/v2_1/profiles/utp/{id}/downlinkRateLimiting

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

  • Response  204

Delete - User Traffic Profile 

/v2_1/profiles/utp/{id}

Use this API command to delete an user traffic profile

  • Response  204

Hotspot Service 

Retrieve List 

/v2_1/rkszones/{zoneId}/portals/hotspot

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

  • Response  200
  • Body
    {
        "totalCount" : 9,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "c5dfc930-75dc-11e4-8d56-00606eb0c700",
            "name" : "protalName1"
        }, {
            "id" : "15efd160-7153-11e4-aa08-00606eb0c700",
            "name" : "protalName2"
        }, {
            "id" : "be0f0480-73a9-11e4-9d1d-f0def13d5845",
            "name" : "protalName3"
        }, {
            "id" : "7f0eef00-7423-11e4-bcef-000c299b4765",
            "name" : "protalName4"
        }, {
            "id" : "4f5c98a0-7123-11e4-bcef-000c299b4765",
            "name" : "protalName5"
        }, {
            "id" : "4a023ce0-73ab-11e4-b211-f0def13d5845",
            "name" : "protalName6"
        }, {
            "id" : "afebbc80-73be-11e4-bfde-f0def13d5845",
            "name" : "protalName7"
        }, {
            "id" : "76f4c020-7620-11e4-b8b9-00606eb0c700",
            "name" : "protalName8"
        }, {
            "id" : "96308310-752c-11e4-8276-00606eb0c700",
            "name" : "protalName9"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the service",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the service"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve 

/v2_1/rkszones/{zoneId}/portals/hotspot/{id}

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

  • Response  200
  • Body
    {
        "name" : "test-hotspot222",
        "id" : "3e5b3782-6f1a-42bf-9812-95d2c1df2451",
        "description" : "description",
        "smartClientSupport" : "None",
        "smartClientInfo" : null,
        "portalType" : "Internal",
        "portalUrl" : null,
        "redirect" : null,
        "userSession" : {
            "timeoutInMin" : 1440,
            "gracePeriodInMin" : 60
        },
        "location" : {
            "id" : "locationId",
            "name" : "locationName"
        },
        "macAddressFormat" : 2,
        "walledGardens" : [ "10.1.1.1", "11.11.111.11" ],
        "zoneId" : "d664f517-cdc5-4997-8248-980a0b7a0542"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the Hotspot",
                "type" : "string"
            },
            "zoneId" : {
                "description" : "Identifier of the zone which the Hotspot belongs to",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot"
            },
            "smartClientSupport" : {
                "description" : "Smart client support of the Hotspot",
                "enum" : [ "None", "Enabled", "SmartClientOnly" ]
            },
            "smartClientInfo" : {
                "description" : "Smart client info of the Hotspot",
                "type" : "string"
            },
            "portalType" : {
                "description" : "Portal type of the Hotspot",
                "enum" : [ "Internal", "External" ]
            },
            "portalUrl" : {
                "type" : "string",
                "description" : "Portal URL of the Hotspot"
            },
            "location" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Portal location id",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Portal location name",
                        "type" : "string"
                    }
                },
                "description" : "Location of the Hotspot"
            },
            "redirect" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "url" : {
                        "type" : "string",
                        "description" : "Portal redirect URL"
                    }
                },
                "description" : "Redirect configuration of the Hotspot"
            },
            "userSession" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "timeoutInMin" : {
                        "description" : "Time out value in minutes",
                        "type" : "integer",
                        "default" : 1440,
                        "minimum" : 2,
                        "maximum" : 14400
                    },
                    "gracePeriodInMin" : {
                        "description" : "Grace period in minutes",
                        "type" : "integer",
                        "default" : 60,
                        "minimum" : 1,
                        "maximum" : 14399
                    }
                },
                "description" : "User session of the Hotspot"
            },
            "walledGardens" : {
                "description" : "Walled garden map set of the Hotspot",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "macAddressFormat" : {
                "description" : "mac address format of redirection",
                "type" : "integer",
                "default" : 2,
                "minimum" : 0,
                "maximum" : 5
            }
        }
    }
    
    

Create Internal 

/v2_1/rkszones/{zoneId}/portals/hotspot/internal

Use this API command to create a new Hotspot(WISPr) with internal logon URL of a zone.MacAddressFormat : 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)

  • Request
  • Body
    {
        "name" : "test-hotspot222",
        "description" : "description",
        "smartClientSupport" : "None",
        "portalUrl" : "https://172.17.26.59",
        "location" : {
            "id" : "locationId",
            "name" : "locationName"
        },
        "macAddressFormat" : 2,
        "walledGardens" : [ "10.11.12.16", "10.11.12.13" ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot"
            },
            "smartClientSupport" : {
                "description" : "Smart client support of the Hotspot",
                "enum" : [ "None", "Enabled" ]
            },
            "location" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Portal location id",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Portal location name",
                        "type" : "string"
                    }
                },
                "description" : "Location of the Hotspot"
            },
            "redirect" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "url" : {
                        "type" : "string",
                        "description" : "Portal redirect URL"
                    }
                },
                "description" : "Redirect configuration of the Hotspot"
            },
            "userSession" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "timeoutInMin" : {
                        "description" : "Time out value in minutes",
                        "type" : "integer",
                        "default" : 1440,
                        "minimum" : 2,
                        "maximum" : 14400
                    },
                    "gracePeriodInMin" : {
                        "description" : "Grace period in minutes",
                        "type" : "integer",
                        "default" : 60,
                        "minimum" : 1,
                        "maximum" : 14399
                    }
                },
                "description" : "User session of the Hotspot"
            },
            "walledGardens" : {
                "description" : "Walled garden map set of the Hotspot",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "macAddressFormat" : {
                "description" : "mac address format of redirection",
                "type" : "integer",
                "default" : 2,
                "minimum" : 0,
                "maximum" : 5
            }
        },
        "required" : [ "name", "smartClientSupport", "macAddressFormat" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the created portal profile",
                "type" : "string"
            }
        }
    }
    
    

Create External 

/v2_1/rkszones/{zoneId}/portals/hotspot/external

Use this API command to create a new Hotspot(WISPr) with external logon URL of a zone.MacAddressFormat : 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)

  • Request
  • Body
    {
        "name" : "test-hotspot222",
        "description" : "description",
        "smartClientSupport" : "None",
        "portalUrl" : "https://172.17.26.59",
        "location" : {
            "id" : "locationId",
            "name" : "locationName"
        },
        "macAddressFormat" : 2,
        "walledGardens" : [ "10.11.12.16", "10.11.12.13" ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot"
            },
            "smartClientSupport" : {
                "description" : "Smart client support of the Hotspot",
                "enum" : [ "None", "Enabled" ]
            },
            "portalUrl" : {
                "type" : "string",
                "description" : "Portal URL of the Hotspot"
            },
            "location" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Portal location id",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Portal location name",
                        "type" : "string"
                    }
                },
                "description" : "Location of the hotspot"
            },
            "redirect" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "url" : {
                        "type" : "string",
                        "description" : "Portal redirect URL"
                    }
                },
                "description" : "Redirect configuration of the Hotspot"
            },
            "userSession" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "timeoutInMin" : {
                        "description" : "Time out value in minutes",
                        "type" : "integer",
                        "default" : 1440,
                        "minimum" : 2,
                        "maximum" : 14400
                    },
                    "gracePeriodInMin" : {
                        "description" : "Grace period in minutes",
                        "type" : "integer",
                        "default" : 60,
                        "minimum" : 1,
                        "maximum" : 14399
                    }
                },
                "description" : "User session of the Hotspot"
            },
            "walledGardens" : {
                "description" : "Walled garden map set of the Hotspot",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "macAddressFormat" : {
                "description" : "mac address format of redirection",
                "type" : "integer",
                "default" : 2,
                "minimum" : 0,
                "maximum" : 5
            }
        },
        "required" : [ "name", "smartClientSupport", "portalUrl", "macAddressFormat" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the created portal profile",
                "type" : "string"
            }
        }
    }
    
    

Create Smart Client Only 

/v2_1/rkszones/{zoneId}/portals/hotspot/smartClientOnly

Use this API command to create a new Hotspot(WISPr) with smart client only of a zone.MacAddressFormat : 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)

  • Request
  • Body
    {
        "name" : "test-hotspot222-smartClientOnly",
        "description" : "description-smartClientOnly",
        "smartClientInfo" : "smartClient only, yyyy!",
        "location" : {
            "id" : "locationId",
            "name" : "locationName"
        },
        "macAddressFormat" : 2,
        "walledGardens" : [ "10.11.12.16", "10.11.12.13" ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot"
            },
            "smartClientInfo" : {
                "description" : "Smart client info of the Hotspot",
                "type" : "string"
            },
            "location" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Portal location id",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Portal location name",
                        "type" : "string"
                    }
                },
                "description" : "Location of the Hotspot"
            },
            "redirect" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "url" : {
                        "type" : "string",
                        "description" : "Portal redirect URL"
                    }
                },
                "description" : "Redirect configuration of the Hotspot"
            },
            "userSession" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "timeoutInMin" : {
                        "description" : "Time out value in minutes",
                        "type" : "integer",
                        "default" : 1440,
                        "minimum" : 2,
                        "maximum" : 14400
                    },
                    "gracePeriodInMin" : {
                        "description" : "Grace period in minutes",
                        "type" : "integer",
                        "default" : 60,
                        "minimum" : 1,
                        "maximum" : 14399
                    }
                },
                "description" : "Redirect configuration of the Hotspot profile"
            },
            "walledGardens" : {
                "description" : "Walled garden map set of the Hotspot",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "macAddressFormat" : {
                "description" : "mac address format of redirection",
                "type" : "integer",
                "default" : 2,
                "minimum" : 0,
                "maximum" : 5
            }
        },
        "required" : [ "name", "smartClientInfo", "macAddressFormat" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the created portal profile",
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v2_1/rkszones/{zoneId}/portals/hotspot/{id}

Use this API command to modify the basic information on Hotspot(WISPr) of a zone.MacAddressFormat : 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)

  • Request
  • Body
    {
        "name" : "test-hotspot-modify",
        "description" : "description-modify",
        "smartClientSupport" : "Enabled",
        "smartClientInfo" : "info",
        "portalUrl" : "https://172.17.26.59",
        "macAddressFormat" : 2
    }
    
    
    Schema
    {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the Hotspot"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Hotspot"
        },
        "smartClientSupport" : {
            "description" : "Smart client support of the Hotspot",
            "enum" : [ "None", "Enabled" ]
        },
        "smartClientInfo" : {
            "description" : "Smart client info of the Hotspot",
            "type" : "string"
        },
        "portalUrl" : {
            "type" : "string",
            "description" : "Portal URL of the Hotspot"
        },
        "macAddressFormat" : {
            "description" : "mac address format of redirection",
            "type" : "integer",
            "default" : 2,
            "minimum" : 0,
            "maximum" : 5
        }
    }
    
    
  • Response  204

Modify Redirect 

/v2_1/rkszones/{zoneId}/portals/hotspot/{id}/redirect

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

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

Modify Location 

/v2_1/rkszones/{zoneId}/portals/hotspot/{id}/location

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

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

Modify Walled Gardens 

/v2_1/rkszones/{zoneId}/portals/hotspot/{id}/walledGardens

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

  • Request
  • Body
    [ "10.1.1.1", "11.11.111.11" ]
    
    
    Schema
    {
        "description" : "Walled garden map set of the Hotspot",
        "type" : "array",
        "items" : {
            "type" : "string"
        }
    }
    
    
  • Response  204

Delete 

/v2_1/rkszones/{zoneId}/portals/hotspot/{id}

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

  • Response  204

Hotspot20 WLAN Profile 

Retrieve List 

/v2_1/rkszones/{zoneId}/hs20s

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

  • Response  200
  • Body
    {
        "totalCount" : 9,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "c5dfc930-75dc-11e4-8d56-00606eb0c700",
            "name" : "protalName1"
        }, {
            "id" : "15efd160-7153-11e4-aa08-00606eb0c700",
            "name" : "protalName2"
        }, {
            "id" : "be0f0480-73a9-11e4-9d1d-f0def13d5845",
            "name" : "protalName3"
        }, {
            "id" : "7f0eef00-7423-11e4-bcef-000c299b4765",
            "name" : "protalName4"
        }, {
            "id" : "4f5c98a0-7123-11e4-bcef-000c299b4765",
            "name" : "protalName5"
        }, {
            "id" : "4a023ce0-73ab-11e4-b211-f0def13d5845",
            "name" : "protalName6"
        }, {
            "id" : "afebbc80-73be-11e4-bfde-f0def13d5845",
            "name" : "protalName7"
        }, {
            "id" : "76f4c020-7620-11e4-b8b9-00606eb0c700",
            "name" : "protalName8"
        }, {
            "id" : "96308310-752c-11e4-8276-00606eb0c700",
            "name" : "protalName9"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the service",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the service"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve 

/v2_1/rkszones/{zoneId}/hs20s/{id}

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

  • Response  200
  • Body
    {
        "id" : "b6af6e80-8409-11e4-a4e7-80fa5b024259",
        "name" : "test-hs20Wlan",
        "description" : "test-hs20Wlan-desc",
        "operator" : {
            "id" : "e6373c40-8194-11e4-aa2e-000c299b4765",
            "name" : "operatorTEST"
        },
        "identityProviders" : [ {
            "id" : "9eec1055-45dd-45c5-a631-f1b76530bb67",
            "name" : "identityProviderDisabled"
        }, {
            "id" : "5fc11810-c8bd-4876-9acf-356a1f4727a3",
            "name" : "identityProviderEnabled"
        } ],
        "defaultIdentityProvider" : {
            "id" : "5fc11810-c8bd-4876-9acf-356a1f4727a3",
            "name" : "identityProviderEnabled"
        },
        "signupSsid" : {
            "id" : "1",
            "name" : "osenWlan"
        },
        "internetOption" : true,
        "accessNetworkType" : "FREE_PUBLIC",
        "ipv4AddressType" : "UNAVAILABLE",
        "ipv6AddressType" : "UNAVAILABLE",
        "connectionCapabilities" : [ {
            "protocolName" : "ICMP",
            "protocolNumber" : 1,
            "portNumber" : 0,
            "status" : "OPEN"
        }, {
            "protocolName" : "FTP",
            "protocolNumber" : 6,
            "portNumber" : 20,
            "status" : "OPEN"
        }, {
            "protocolName" : "SSH",
            "protocolNumber" : 6,
            "portNumber" : 22,
            "status" : "CLOSED"
        }, {
            "protocolName" : "HTTP",
            "protocolNumber" : 6,
            "portNumber" : 80,
            "status" : "CLOSED"
        }, {
            "protocolName" : "Used by TLS VPN",
            "protocolNumber" : 6,
            "portNumber" : 443,
            "status" : "CLOSED"
        }, {
            "protocolName" : "Used by PPTP VPNs",
            "protocolNumber" : 6,
            "portNumber" : 1723,
            "status" : "CLOSED"
        }, {
            "protocolName" : "VoIP",
            "protocolNumber" : 6,
            "portNumber" : 5060,
            "status" : "CLOSED"
        }, {
            "protocolName" : "VoIP",
            "protocolNumber" : 17,
            "portNumber" : 5060,
            "status" : "CLOSED"
        }, {
            "protocolName" : "Used by IKEv2(IPSec VPN)",
            "protocolNumber" : 17,
            "portNumber" : 500,
            "status" : "CLOSED"
        }, {
            "protocolName" : "IPSec VPN",
            "protocolNumber" : 17,
            "portNumber" : 4500,
            "status" : "CLOSED"
        }, {
            "protocolName" : "ESP",
            "protocolNumber" : 50,
            "portNumber" : 0,
            "status" : "CLOSED"
        } ],
        "customConnectionCapabilities" : [ {
            "protocolName" : "ICMP",
            "protocolNumber" : 2,
            "portNumber" : 0,
            "status" : "OPEN"
        }, {
            "protocolName" : "FTP",
            "protocolNumber" : 2,
            "portNumber" : 20,
            "status" : "OPEN"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the Hotspot 2.0 WLAN profile",
                "type" : "string"
            },
            "zoneId" : {
                "description" : "Identifier of the zone which the Hotspot 2.0 WLAN profile belongs to",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot 2.0 WLAN profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot 2.0 WLAN profile"
            },
            "operator" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Operator of the Hotspot 2.0 WLAN profile"
            },
            "identityProviders" : {
                "description" : "Identity providers of the Hotspot 2.0 WLAN profile",
                "type" : "array",
                "items" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "defaultIdentityProvider" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Default identity provider of the Hotspot 2.0 WLAN profile"
            },
            "signupSsid" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Signup SSID of the Hotspot 2.0 WLAN profile"
            },
            "internetOption" : {
                "description" : "Internet option of the Hotspot 2.0 WLAN profile",
                "type" : "boolean"
            },
            "accessNetworkType" : {
                "description" : "Access network type of the Hotspot 2.0 WLAN profile",
                "enum" : [ "CHARGEABLE_PUBLIC", "FREE_PUBLIC", "PERSONAL_DEVICE", "PRIVATE", "PRIVATE_WITH_GUEST", "TEST", "WILDCARD" ]
            },
            "ipv4AddressType" : {
                "description" : "IPv4 address type of the v WLAN profile",
                "enum" : [ "UNAVAILABLE", "PUBLIC", "PORT_RESTRICTED", "SINGLE_NATED_PRIVATE", "DOUBLE_NATED_PRIVATE", "PORT_RESTRICTED_AND_SINGLE_NATED", "PORT_RESTRICTED_AND_DOUBLE_NATED", "UNKNOWN" ]
            },
            "ipv6AddressType" : {
                "description" : "IPv6 address type of the Hotspot 2.0 WLAN profile",
                "enum" : [ "UNAVAILABLE", "AVAILABLE", "UNKNOWN" ]
            },
            "connectionCapabilities" : {
                "description" : "Default connection capabilities of the Hotspot 2.0 WLAN profile",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "protocolName" : {
                            "description" : "Protocol aame of connection capability, cannot be modified",
                            "type" : "string",
                            "pattern" : "^[!-~]([ -~]){0,31}$"
                        },
                        "protocolNumber" : {
                            "description" : "Protocol number of connection capability, cannot be modified",
                            "type" : "number",
                            "minimum" : 0,
                            "maximum" : 254
                        },
                        "portNumber" : {
                            "description" : "Port number of connection capability, cannot be modified",
                            "type" : "number",
                            "minimum" : 0,
                            "maximum" : 65535
                        },
                        "status" : {
                            "description" : "Status of connection capability",
                            "enum" : [ "CLOSED", "OPEN", "UNKNOWN" ]
                        }
                    },
                    "required" : [ "protocolName", "protocolNumber", "portNumber", "status" ]
                }
            },
            "customConnectionCapabilities" : {
                "description" : "Custom connection capabilities of the Hotspot 2.0 WLAN profile",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "protocolName" : {
                            "description" : "Protocol aame of connection capability",
                            "type" : "string",
                            "pattern" : "^[!-~]([ -~]){0,31}$"
                        },
                        "protocolNumber" : {
                            "description" : "Protocol number of connection capability",
                            "type" : "number",
                            "minimum" : 0,
                            "maximum" : 254
                        },
                        "portNumber" : {
                            "description" : "Port number of connection capability",
                            "type" : "number",
                            "minimum" : 0,
                            "maximum" : 65535
                        },
                        "status" : {
                            "description" : "Status of connection capability",
                            "enum" : [ "CLOSED", "OPEN", "UNKNOWN" ]
                        }
                    },
                    "required" : [ "protocolName", "protocolNumber", "portNumber", "status" ]
                }
            }
        }
    }
    
    

Create 

/v2_1/rkszones/{zoneId}/hs20s

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

  • Request
  • Body
    {
        "name" : "hotspot20WlanCreate",
        "description" : "hotspot20 Wlan profile Create desc",
        "operator" : {
            "id" : "e6373c40-8194-11e4-aa2e-000c299b4765",
            "name" : "operatorTEST"
        },
        "identityProviders" : [ {
            "id" : "9eec1055-45dd-45c5-a631-f1b76530bb67",
            "name" : "identityProviderDisabled"
        }, {
            "id" : "5fc11810-c8bd-4876-9acf-356a1f4727a3",
            "name" : "identityProviderEnabled"
        } ],
        "defaultIdentityProvider" : {
            "id" : "5fc11810-c8bd-4876-9acf-356a1f4727a3",
            "name" : "identityProviderEnabled"
        },
        "signupSsid" : {
            "id" : "1",
            "name" : "osenWlan"
        },
        "internetOption" : true,
        "accessNetworkType" : "CHARGEABLE_PUBLIC",
        "ipv4AddressType" : "UNAVAILABLE",
        "ipv6AddressType" : "UNAVAILABLE"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot 2.0 WLAN profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot 2.0 WLAN profile"
            },
            "operator" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Operator of the Hotspot 2.0 WLAN profile"
            },
            "identityProviders" : {
                "description" : "Ddentity providers of the Hotspot 2.0 WLAN profile",
                "type" : "array",
                "items" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "defaultIdentityProvider" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Default identity provider of the Hotspot 2.0 WLAN profile"
            },
            "signupSsid" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Signup SSID of the Hotspot 2.0 WLAN profile"
            },
            "internetOption" : {
                "description" : "Internet option of the Hotspot 2.0 WLAN profile",
                "type" : "boolean"
            },
            "accessNetworkType" : {
                "description" : "Access network type of the Hotspot 2.0 WLAN profile",
                "enum" : [ "CHARGEABLE_PUBLIC", "FREE_PUBLIC", "PERSONAL_DEVICE", "PRIVATE", "PRIVATE_WITH_GUEST", "TEST", "WILDCARD" ]
            },
            "ipv4AddressType" : {
                "description" : "IPv4 address type of the Hotspot 2.0 WLAN profile",
                "enum" : [ "UNAVAILABLE", "PUBLIC", "PORT_RESTRICTED", "SINGLE_NATED_PRIVATE", "DOUBLE_NATED_PRIVATE", "PORT_RESTRICTED_AND_SINGLE_NATED", "PORT_RESTRICTED_AND_DOUBLE_NATED", "UNKNOWN" ]
            },
            "ipv6AddressType" : {
                "description" : "IPv6 address type of the Hotspot 2.0 WLAN profile",
                "enum" : [ "UNAVAILABLE", "AVAILABLE", "UNKNOWN" ]
            }
        },
        "required" : [ "name", "operator", "defaultIdentityProvider", "internetOption", "accessNetworkType", "ipv4AddressType", "ipv6AddressType" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the created portal profile",
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v2_1/rkszones/{zoneId}/hs20s/{id}

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

  • Request
  • Body
    {
        "name" : "hotspot20WlanProfilePath",
        "description" : "hotspot20 wlan profile pathc desc",
        "internetOption" : true,
        "accessNetworkType" : "CHARGEABLE_PUBLIC",
        "ipv4AddressType" : "UNAVAILABLE",
        "ipv6AddressType" : "UNAVAILABLE"
    }
    
    
    Schema
    {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the Hotspot 2.0 WLAN profile"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Hotspot 2.0 WLAN profile"
        },
        "internetOption" : {
            "description" : "Internet option of the Hotspot 2.0 WLAN profile",
            "type" : "boolean"
        },
        "accessNetworkType" : {
            "description" : "Access network type of the Hotspot 2.0 WLAN profile",
            "enum" : [ "CHARGEABLE_PUBLIC", "FREE_PUBLIC", "PERSONAL_DEVICE", "PRIVATE", "PRIVATE_WITH_GUEST", "TEST", "WILDCARD" ]
        },
        "ipv4AddressType" : {
            "description" : "IPv4 address type of the Hotspot 2.0 Wlan profile",
            "enum" : [ "UNAVAILABLE", "PUBLIC", "PORT_RESTRICTED", "SINGLE_NATED_PRIVATE", "DOUBLE_NATED_PRIVATE", "PORT_RESTRICTED_AND_SINGLE_NATED", "PORT_RESTRICTED_AND_DOUBLE_NATED", "UNKNOWN" ]
        },
        "ipv6AddressType" : {
            "description" : "IPv6 address type of the Hotspot 2.0 Wlan profile",
            "enum" : [ "UNAVAILABLE", "AVAILABLE", "UNKNOWN" ]
        }
    }
    
    
  • Response  204

Modify Operator 

/v2_1/rkszones/{zoneId}/hs20s/{id}/operator

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

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

Modify Identity Providers 

/v2_1/rkszones/{zoneId}/hs20s/{id}/identityProviders

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

  • Request
  • Body
    [ {
        "id" : "9eec1055-45dd-45c5-a631-f1b76530bb67",
        "name" : "identityProviderDisabled"
    }, {
        "id" : "5fc11810-c8bd-4876-9acf-356a1f4727a3",
        "name" : "identityProviderEnabled"
    } ]
    
    
    Schema
    {
        "description" : "Identity providers of the Hotspot 2.0 WLAN profile",
        "type" : "array",
        "items" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        }
    }
    
    
  • Response  204

Modify Default Identity Provider 

/v2_1/rkszones/{zoneId}/hs20s/{id}/defaultIdentityProvider

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

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

Modify Signup SSID 

/v2_1/rkszones/{zoneId}/hs20s/{id}/signupSsid

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

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

Modify Default Connection Capabilities 

/v2_1/rkszones/{zoneId}/hs20s/{id}/connectionCapabilities

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

  • Request
  • Body
    [ {
        "protocolName" : "ICMP",
        "protocolNumber" : 1,
        "portNumber" : 0,
        "status" : "OPEN"
    }, {
        "protocolName" : "FTP",
        "protocolNumber" : 6,
        "portNumber" : 20,
        "status" : "OPEN"
    }, {
        "protocolName" : "SSH",
        "protocolNumber" : 6,
        "portNumber" : 22,
        "status" : "UNKNOWN"
    }, {
        "protocolName" : "HTTP",
        "protocolNumber" : 6,
        "portNumber" : 80,
        "status" : "CLOSED"
    }, {
        "protocolName" : "Used by TLS VPN",
        "protocolNumber" : 6,
        "portNumber" : 443,
        "status" : "CLOSED"
    }, {
        "protocolName" : "Used by PPTP VPNs",
        "protocolNumber" : 6,
        "portNumber" : 1723,
        "status" : "CLOSED"
    }, {
        "protocolName" : "VoIP",
        "protocolNumber" : 6,
        "portNumber" : 5060,
        "status" : "CLOSED"
    }, {
        "protocolName" : "VoIP",
        "protocolNumber" : 17,
        "portNumber" : 5060,
        "status" : "CLOSED"
    }, {
        "protocolName" : "Used by IKEv2(IPSec VPN)",
        "protocolNumber" : 17,
        "portNumber" : 500,
        "status" : "CLOSED"
    }, {
        "protocolName" : "IPSec VPN",
        "protocolNumber" : 17,
        "portNumber" : 4500,
        "status" : "CLOSED"
    }, {
        "protocolName" : "ESP",
        "protocolNumber" : 50,
        "portNumber" : 0,
        "status" : "CLOSED"
    } ]
    
    
    Schema
    {
        "description" : "Default connection capabilities of the Hotspot 2.0 WLAN profile",
        "type" : "array",
        "items" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "protocolName" : {
                    "description" : "Protocol aame of connection capability, cannot be modified",
                    "type" : "string",
                    "pattern" : "^[!-~]([ -~]){0,31}$"
                },
                "protocolNumber" : {
                    "description" : "Protocol number of connection capability, cannot be modified",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 254
                },
                "portNumber" : {
                    "description" : "Port number of connection capability, cannot be modified",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 65535
                },
                "status" : {
                    "description" : "Status of connection capability",
                    "enum" : [ "CLOSED", "OPEN", "UNKNOWN" ]
                }
            },
            "required" : [ "protocolName", "protocolNumber", "portNumber", "status" ]
        }
    }
    
    
  • Response  204

Modify Custom Connection Capabilities 

/v2_1/rkszones/{zoneId}/hs20s/{id}/customConnectionCapabilities

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

  • Request
  • Body
    [ {
        "protocolName" : "ICMP",
        "protocolNumber" : 2,
        "portNumber" : 0,
        "status" : "OPEN"
    }, {
        "protocolName" : "FTP",
        "protocolNumber" : 2,
        "portNumber" : 20,
        "status" : "OPEN"
    } ]
    
    
    Schema
    {
        "description" : "Custom connection capabilities of the Hotspot 2.0 WLAN profile",
        "type" : "array",
        "items" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "protocolName" : {
                    "description" : "Protocol aame of connection capability",
                    "type" : "string",
                    "pattern" : "^[!-~]([ -~]){0,31}$"
                },
                "protocolNumber" : {
                    "description" : "Protocol number of connection capability",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 254
                },
                "portNumber" : {
                    "description" : "Port number of connection capability",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 65535
                },
                "status" : {
                    "description" : "Status of connection capability",
                    "enum" : [ "CLOSED", "OPEN", "UNKNOWN" ]
                }
            },
            "required" : [ "protocolName", "protocolNumber", "portNumber", "status" ]
        }
    }
    
    
  • Response  204

Delete 

/v2_1/rkszones/{zoneId}/hs20s/{id}

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

  • Response  204

Authentication Service 

Retrieve List - RADIUS Authentication Service 

/v2_1/services/auth/radius

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

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "82109ce0-64e6-11e4-8916-0026b9f85aaf",
            "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
            "name" : "rapheal-auth-x3",
            "friendlyName" : "rapheal-auth-x",
            "description" : "authentication service created by rapheal via public API",
            "mappings" : [ {
                "id" : "73587760-6589-11e4-800c-0026b9f85aaf",
                "groupAttr" : "abc",
                "userRole" : {
                    "id" : "a4c288b0-63cf-11e4-a18a-080027b147d4",
                    "name" : "identity user role name",
                    "userTrafficProfile" : {
                        "id" : "9474cc20-63cf-11e4-a18a-080027b147d4",
                        "name" : "rapheal-usertraffic-profile"
                    }
                }
            }, {
                "id" : "735e6ad0-6589-11e4-800c-0026b9f85aaf",
                "groupAttr" : "*",
                "userRole" : {
                    "id" : "9ac45fd6-a87b-4eef-87d7-b759fed376c5",
                    "name" : "identity user role name",
                    "userTrafficProfile" : {
                        "id" : "03ec5340-60a4-11e4-87fc-080027b147d4",
                        "name" : "System Default"
                    }
                }
            } ],
            "primary" : {
                "ip" : "1.1.1.155",
                "port" : 1812,
                "sharedSecret" : "abc"
            },
            "secondary" : {
                "ip" : "2.2.2.231",
                "port" : 1812,
                "sharedSecret" : "abc"
            },
            "healthCheckPolicy" : {
                "responseWindow" : 20,
                "reviveInterval" : 120,
                "zombiePeriod" : 40
            },
            "rateLimiting" : {
                "maxOutstandingRequestsPerServer" : 0,
                "threshold" : 0,
                "sanityTimer" : 10
            }
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the RADIUS authentication service",
                            "type" : "string"
                        },
                        "mvnoId" : {
                            "description" : "Tenant UUID",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the RADIUS authentication service"
                        },
                        "friendlyName" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Friendly name of the RADIUS authentication service"
                        },
                        "description" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 64,
                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                            "description" : "Description of the RADIUS authentication service"
                        },
                        "locationDeliveryEnabled" : {
                            "description" : "RFC5580 out of band location delivery support(for Ruckus AP only)",
                            "type" : "boolean",
                            "default" : false
                        },
                        "primary" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "ip" : {
                                    "type" : "string",
                                    "description" : "Server IP"
                                },
                                "port" : {
                                    "description" : "Server port",
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                },
                                "sharedSecret" : {
                                    "description" : "Server shared secrect",
                                    "type" : "string"
                                }
                            },
                            "required" : [ "ip", "port", "sharedSecret" ],
                            "description" : "Primary RADIUS server"
                        },
                        "secondary" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "autoFallbackDisable" : {
                                    "descriptin" : "Automatic fallback enabled or disabled",
                                    "type" : "boolean"
                                },
                                "ip" : {
                                    "type" : "string",
                                    "description" : "RADIUS server IP"
                                },
                                "port" : {
                                    "description" : "RADIUS server port",
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 1812
                                },
                                "sharedSecret" : {
                                    "description" : "RADIUS server shared secrect",
                                    "type" : "string"
                                }
                            },
                            "required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
                            "description" : "Secondary RADIUS server"
                        },
                        "healthCheckPolicy" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "responseWindow" : {
                                    "description" : "Response window",
                                    "type" : "integer",
                                    "minimum" : 5,
                                    "maximum" : 30,
                                    "default" : 20
                                },
                                "reviveInterval" : {
                                    "description" : "Revive interval",
                                    "type" : "integer",
                                    "minimum" : 60,
                                    "maximum" : 3600,
                                    "default" : 120
                                },
                                "zombiePeriod" : {
                                    "description" : "Zombie period",
                                    "type" : "integer",
                                    "minimum" : 30,
                                    "maximum" : 120,
                                    "default" : 40
                                }
                            },
                            "required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
                            "description" : "Health check policy"
                        },
                        "rateLimiting" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "maxOutstandingRequestsPerServer" : {
                                    "description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
                                    "type" : "integer",
                                    "default" : 0
                                },
                                "threshold" : {
                                    "description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
                                    "type" : "integer",
                                    "default" : 0
                                },
                                "sanityTimer" : {
                                    "description" : "Sanity timer ",
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 3600,
                                    "default" : 10
                                }
                            },
                            "required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
                            "description" : "Rate limiting"
                        },
                        "mappings" : {
                            "type" : "array",
                            "description" : "Group attribute and user traffic profile mapping",
                            "items" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "description" : "User traffic profile mapping",
                                "properties" : {
                                    "id" : {
                                        "type" : "string",
                                        "description" : "Group attribute mapping UUID"
                                    },
                                    "groupAttr" : {
                                        "type" : "string",
                                        "description" : "Group attribute"
                                    },
                                    "userRole" : {
                                        "type" : "object",
                                        "additionalProperties" : false,
                                        "description" : "Identity user role",
                                        "properties" : {
                                            "id" : {
                                                "type" : "string",
                                                "description" : "Identity user role UUID"
                                            },
                                            "name" : {
                                                "type" : "string",
                                                "minLength" : 2,
                                                "maxLength" : 32,
                                                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                                "description" : "Identity user role name"
                                            },
                                            "userTrafficProfile" : {
                                                "type" : "object",
                                                "description" : "Identity user role",
                                                "properties" : {
                                                    "id" : {
                                                        "type" : "string",
                                                        "description" : "User traffic profile UUID"
                                                    },
                                                    "name" : {
                                                        "type" : "string",
                                                        "description" : "User traffic profile name"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "required" : [ "groupAttr", "userRole" ]
                            }
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve - RADIUS Authentication Service 

/v2_1/services/auth/radius/{id}

Use this API command to retrieve a RADIUS authentication service.

  • Response  200
  • Body
    {
        "id" : "82109ce0-64e6-11e4-8916-0026b9f85aaf",
        "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
        "name" : "rapheal-auth-x3",
        "friendlyName" : "rapheal-auth-x",
        "description" : "authentication service created by rapheal via public API",
        "mappings" : [ {
            "id" : "73587760-6589-11e4-800c-0026b9f85aaf",
            "groupAttr" : "abc",
            "userRole" : {
                "id" : "a4c288b0-63cf-11e4-a18a-080027b147d4",
                "name" : "identity user role name",
                "userTrafficProfile" : {
                    "id" : "9474cc20-63cf-11e4-a18a-080027b147d4",
                    "name" : "rapheal-usertraffic-profile"
                }
            }
        }, {
            "id" : "735e6ad0-6589-11e4-800c-0026b9f85aaf",
            "groupAttr" : "*",
            "userRole" : {
                "id" : "9ac45fd6-a87b-4eef-87d7-b759fed376c5",
                "name" : "identity user role name",
                "userTrafficProfile" : {
                    "id" : "03ec5340-60a4-11e4-87fc-080027b147d4",
                    "name" : "System Default"
                }
            }
        } ],
        "primary" : {
            "ip" : "1.1.1.155",
            "port" : 1812,
            "sharedSecret" : "abc"
        },
        "secondary" : {
            "ip" : "2.2.2.231",
            "port" : 1812,
            "sharedSecret" : "abc"
        },
        "healthCheckPolicy" : {
            "responseWindow" : 20,
            "reviveInterval" : 120,
            "zombiePeriod" : 40
        },
        "rateLimiting" : {
            "maxOutstandingRequestsPerServer" : 0,
            "threshold" : 0,
            "sanityTimer" : 10
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the RADIUS authentication service",
                "type" : "string"
            },
            "mvnoId" : {
                "description" : "Tenant UUID",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the RADIUS authentication service"
            },
            "friendlyName" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Friendly name of the RADIUS authentication service"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the RADIUS authentication service"
            },
            "locationDeliveryEnabled" : {
                "description" : "RFC5580 out of band location delivery support(for Ruckus AP only)",
                "type" : "boolean",
                "default" : false
            },
            "primary" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "ip" : {
                        "type" : "string",
                        "description" : "Server IP"
                    },
                    "port" : {
                        "description" : "Server port",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 65535
                    },
                    "sharedSecret" : {
                        "description" : "Server shared secrect",
                        "type" : "string"
                    }
                },
                "required" : [ "ip", "port", "sharedSecret" ],
                "description" : "Primary RADIUS server"
            },
            "secondary" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "autoFallbackDisable" : {
                        "descriptin" : "Automatic fallback enabled or disabled",
                        "type" : "boolean"
                    },
                    "ip" : {
                        "type" : "string",
                        "description" : "RADIUS server IP"
                    },
                    "port" : {
                        "description" : "RADIUS server port",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 65535,
                        "default" : 1812
                    },
                    "sharedSecret" : {
                        "description" : "RADIUS server shared secrect",
                        "type" : "string"
                    }
                },
                "required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
                "description" : "Secondary RADIUS server"
            },
            "healthCheckPolicy" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "responseWindow" : {
                        "description" : "Response window",
                        "type" : "integer",
                        "minimum" : 5,
                        "maximum" : 30,
                        "default" : 20
                    },
                    "reviveInterval" : {
                        "description" : "Revive interval",
                        "type" : "integer",
                        "minimum" : 60,
                        "maximum" : 3600,
                        "default" : 120
                    },
                    "zombiePeriod" : {
                        "description" : "Zombie period",
                        "type" : "integer",
                        "minimum" : 30,
                        "maximum" : 120,
                        "default" : 40
                    }
                },
                "required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
                "description" : "Health check policy"
            },
            "rateLimiting" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "maxOutstandingRequestsPerServer" : {
                        "description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
                        "type" : "integer",
                        "default" : 0
                    },
                    "threshold" : {
                        "description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
                        "type" : "integer",
                        "default" : 0
                    },
                    "sanityTimer" : {
                        "description" : "Sanity timer ",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 3600,
                        "default" : 10
                    }
                },
                "required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
                "description" : "Rate limiting"
            },
            "mappings" : {
                "type" : "array",
                "description" : "Group attribute and user traffic profile mapping",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "description" : "User traffic profile mapping",
                    "properties" : {
                        "id" : {
                            "type" : "string",
                            "description" : "Group attribute mapping UUID"
                        },
                        "groupAttr" : {
                            "type" : "string",
                            "description" : "Group attribute"
                        },
                        "userRole" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "description" : "Identity user role",
                            "properties" : {
                                "id" : {
                                    "type" : "string",
                                    "description" : "Identity user role UUID"
                                },
                                "name" : {
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32,
                                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                    "description" : "Identity user role name"
                                },
                                "userTrafficProfile" : {
                                    "type" : "object",
                                    "description" : "Identity user role",
                                    "properties" : {
                                        "id" : {
                                            "type" : "string",
                                            "description" : "User traffic profile UUID"
                                        },
                                        "name" : {
                                            "type" : "string",
                                            "description" : "User traffic profile name"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "required" : [ "groupAttr", "userRole" ]
                }
            }
        }
    }
    
    

Create - RADIUS Authentication Service 

/v2_1/services/auth/radius

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

  • Request
  • Body
    {
        "name" : "authenticationServiceName",
        "primary" : {
            "ip" : "192.168.1.1",
            "port" : 1812,
            "sharedSecret" : "abc"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the RADIUS authentication service"
            },
            "friendlyName" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Friendly name of the RADIUS authentication service"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the RADIUS authentication service"
            },
            "locationDeliveryEnabled" : {
                "description" : "RFC5580 out of band location delivery support(for Ruckus AP only)",
                "type" : "boolean",
                "default" : false
            },
            "primary" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "ip" : {
                        "type" : "string",
                        "description" : "Server IP"
                    },
                    "port" : {
                        "description" : "Server port",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 65535
                    },
                    "sharedSecret" : {
                        "description" : "Server shared secrect",
                        "type" : "string"
                    }
                },
                "required" : [ "ip", "port", "sharedSecret" ],
                "description" : "Primary RADIUS server"
            },
            "secondary" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "autoFallbackDisable" : {
                        "descriptin" : "Automatic fallback enabled or disabled",
                        "type" : "boolean"
                    },
                    "ip" : {
                        "type" : "string",
                        "description" : "RADIUS server IP"
                    },
                    "port" : {
                        "description" : "RADIUS server port",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 65535,
                        "default" : 1812
                    },
                    "sharedSecret" : {
                        "description" : "RADIUS server shared secrect",
                        "type" : "string"
                    }
                },
                "required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
                "description" : "Secondary RADIUS server"
            },
            "healthCheckPolicy" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "responseWindow" : {
                        "description" : "Response window",
                        "type" : "integer",
                        "minimum" : 5,
                        "maximum" : 30,
                        "default" : 20
                    },
                    "reviveInterval" : {
                        "description" : "Revive interval",
                        "type" : "integer",
                        "minimum" : 60,
                        "maximum" : 3600,
                        "default" : 120
                    },
                    "zombiePeriod" : {
                        "description" : "Zombie period",
                        "type" : "integer",
                        "minimum" : 30,
                        "maximum" : 120,
                        "default" : 40
                    }
                },
                "required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
                "description" : "Health check policy"
            },
            "rateLimiting" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "maxOutstandingRequestsPerServer" : {
                        "description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
                        "type" : "integer",
                        "default" : 0
                    },
                    "threshold" : {
                        "description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
                        "type" : "integer",
                        "default" : 0
                    },
                    "sanityTimer" : {
                        "description" : "Sanity timer ",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 3600,
                        "default" : 10
                    }
                },
                "required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
                "description" : "Rate limiting"
            },
            "mappings" : {
                "type" : "array",
                "description" : "Group attribute and user traffic profile mapping",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "description" : "User traffic profile mapping",
                    "properties" : {
                        "groupAttr" : {
                            "type" : "string",
                            "description" : "Group attribute"
                        },
                        "userRole" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "description" : "Identity user role",
                            "properties" : {
                                "id" : {
                                    "type" : "string",
                                    "description" : "Identity user role UUID"
                                },
                                "name" : {
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32,
                                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                    "description" : "Identity user role name"
                                }
                            }
                        }
                    },
                    "required" : [ "groupAttr", "userRole" ]
                }
            }
        },
        "required" : [ "name", "primary" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "serviceUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Modify - RADIUS Authentication Service 

/v2_1/services/auth/radius/{id}

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

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

Modify - Primary RADIUS Server of Authentication Service 

/v2_1/services/auth/radius/{id}/primary

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

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

Modify - Secondary RADIUS Server of Authentication Service 

/v2_1/services/auth/radius/{id}/secondary

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

  • Request
  • Body
    {
        "ip" : "2.2.2.231",
        "port" : 1812,
        "sharedSecret" : "abc"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "autoFallbackDisable" : {
                "descriptin" : "Automatic fallback enabled or disabled",
                "type" : "boolean"
            },
            "ip" : {
                "type" : "string",
                "description" : "RADIUS server IP"
            },
            "port" : {
                "description" : "RADIUS server port",
                "type" : "integer",
                "minimum" : 1,
                "maximum" : 65535,
                "default" : 1812
            },
            "sharedSecret" : {
                "description" : "RADIUS server shared secrect",
                "type" : "string"
            }
        },
        "required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
        "description" : "Secondary RADIUS server"
    }
    
    
  • Response  204

Modify - Rate Limiting of Authentication Service 

/v2_1/services/auth/radius/{id}/rateLimiting

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

  • Request
  • Body
    {
        "maxOutstandingRequestsPerServer" : 0,
        "threshold" : 0,
        "sanityTimer" : 10
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "maxOutstandingRequestsPerServer" : {
                "description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
                "type" : "integer",
                "default" : 0
            },
            "threshold" : {
                "description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
                "type" : "integer",
                "default" : 0
            },
            "sanityTimer" : {
                "description" : "Sanity timer ",
                "type" : "integer",
                "minimum" : 1,
                "maximum" : 3600,
                "default" : 10
            }
        },
        "required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
        "description" : "Rate limiting"
    }
    
    
  • Response  204

Modify - Health Check Policy of Authentication Service 

/v2_1/services/auth/radius/{id}/healthCheckPolicy

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

  • Request
  • Body
    {
        "responseWindow" : 20,
        "reviveInterval" : 120,
        "zombiePeriod" : 40
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "responseWindow" : {
                "description" : "Response window",
                "type" : "integer",
                "minimum" : 5,
                "maximum" : 30,
                "default" : 20
            },
            "reviveInterval" : {
                "description" : "Revive interval",
                "type" : "integer",
                "minimum" : 60,
                "maximum" : 3600,
                "default" : 120
            },
            "zombiePeriod" : {
                "description" : "Zombie period",
                "type" : "integer",
                "minimum" : 30,
                "maximum" : 120,
                "default" : 40
            }
        },
        "required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
        "description" : "Health check policy"
    }
    
    
  • Response  204

Modify - User Traffic Profile Mapping 

/v2_1/services/auth/radius/{id}/mappings

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

  • Request
  • Body
    [ {
        "groupAttr" : "newGroupAttr",
        "userRole" : {
            "id" : "identity user role UUID"
        }
    }, {
        "groupAttr" : "*",
        "userRole" : {
            "name" : "identity user role name"
        }
    } ]
    
    
    Schema
    {
        "type" : "array",
        "description" : "Group attribute and user traffic profile mapping",
        "items" : {
            "type" : "object",
            "additionalProperties" : false,
            "description" : "User traffic profile mapping",
            "properties" : {
                "groupAttr" : {
                    "type" : "string",
                    "description" : "Group attribute"
                },
                "userRole" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "description" : "Identity user role",
                    "properties" : {
                        "id" : {
                            "type" : "string",
                            "description" : "Identity user role UUID"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Identity user role name"
                        }
                    }
                }
            },
            "required" : [ "groupAttr", "userRole" ]
        }
    }
    
    
  • Response  204

Disable Secondary RADIUS Server of Authentication Service 

/v2_1/services/auth/radius/{id}/secondary

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

  • Response  204

Delete - RADIUS Authentication Service 

/v2_1/services/auth/radius/{id}

Use this API command to delete a RADIUS authentication service.

  • Response  204

Retrieve List - Active Directory Authentication Service 

/v2_1/services/auth/ad

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

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "49322250-6afd-11e4-832a-dc6020524153",
            "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
            "name" : "rapheal-ad",
            "friendlyName" : "",
            "description" : "",
            "mappings" : [ {
                "id" : "c7608860-6afd-11e4-b9bb-08002716c79f",
                "groupAttr" : "*",
                "userRole" : {
                    "id" : "636431d6-c06e-4692-a28f-3914afc2a817",
                    "name" : "identity user role name",
                    "userTrafficProfile" : {
                        "id" : "fbde8510-6972-11e4-926e-08002716c79f",
                        "name" : "System Default"
                    }
                }
            } ],
            "ip" : "1.1.1.1",
            "port" : 3268,
            "windowsDomainName" : "dc=domain",
            "adminDomainName" : "[email protected]",
            "password" : "abced",
            "globalCatalogEnabled" : true
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the active directory authentication service",
                            "type" : "string"
                        },
                        "mvnoId" : {
                            "description" : "Tenant UUID",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the active directory authentication service"
                        },
                        "friendlyName" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Friendly name of the active directory authentication service"
                        },
                        "description" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 64,
                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                            "description" : "Description of the active directory authentication service"
                        },
                        "ip" : {
                            "type" : "string",
                            "description" : "IP address"
                        },
                        "port" : {
                            "description" : "Port",
                            "type" : "integer",
                            "minimum" : 1,
                            "maximum" : 65535,
                            "default" : 389
                        },
                        "windowsDomainName" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 64,
                            "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                            "description" : "Windows domain name"
                        },
                        "adminDomainName" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 64,
                            "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                            "description" : "Admin domain name"
                        },
                        "password" : {
                            "description" : "Admin password",
                            "type" : "string"
                        },
                        "globalCatalogEnabled" : {
                            "description" : "Global catalog support enabled or disabled",
                            "type" : "boolean"
                        },
                        "mappings" : {
                            "type" : "array",
                            "description" : "Group attribute and user traffic profile mapping",
                            "items" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "description" : "User traffic profile mapping",
                                "properties" : {
                                    "id" : {
                                        "type" : "string",
                                        "description" : "Group attribute mapping UUID"
                                    },
                                    "groupAttr" : {
                                        "type" : "string",
                                        "description" : "Group attribute"
                                    },
                                    "userRole" : {
                                        "type" : "object",
                                        "additionalProperties" : false,
                                        "description" : "Identity user role",
                                        "properties" : {
                                            "id" : {
                                                "type" : "string",
                                                "description" : "Identity user role UUID"
                                            },
                                            "name" : {
                                                "type" : "string",
                                                "minLength" : 2,
                                                "maxLength" : 32,
                                                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                                "description" : "Identity user role name"
                                            },
                                            "userTrafficProfile" : {
                                                "type" : "object",
                                                "description" : "Identity user role",
                                                "properties" : {
                                                    "id" : {
                                                        "type" : "string",
                                                        "description" : "User traffic profile UUID"
                                                    },
                                                    "name" : {
                                                        "type" : "string",
                                                        "description" : "User traffic profile name"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "required" : [ "groupAttr", "userRole" ]
                            }
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve - Active Directory Authentication Service 

/v2_1/services/auth/ad/{id}

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

  • Response  200
  • Body
    {
        "id" : "49322250-6afd-11e4-832a-dc6020524153",
        "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
        "name" : "rapheal-ad",
        "friendlyName" : "",
        "description" : "",
        "mappings" : [ {
            "id" : "c7608860-6afd-11e4-b9bb-08002716c79f",
            "groupAttr" : "*",
            "userRole" : {
                "id" : "636431d6-c06e-4692-a28f-3914afc2a817",
                "name" : "identity user role name",
                "userTrafficProfile" : {
                    "id" : "fbde8510-6972-11e4-926e-08002716c79f",
                    "name" : "System Default"
                }
            }
        } ],
        "ip" : "1.1.1.1",
        "port" : 3268,
        "windowsDomainName" : "dc=domain",
        "adminDomainName" : "[email protected]",
        "password" : "abced",
        "globalCatalogEnabled" : true
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the active directory authentication service",
                "type" : "string"
            },
            "mvnoId" : {
                "description" : "Tenant UUID",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the active directory authentication service"
            },
            "friendlyName" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Friendly name of the active directory authentication service"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the active directory authentication service"
            },
            "ip" : {
                "type" : "string",
                "description" : "IP address"
            },
            "port" : {
                "description" : "Port",
                "type" : "integer",
                "minimum" : 1,
                "maximum" : 65535,
                "default" : 389
            },
            "windowsDomainName" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 64,
                "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                "description" : "Windows domain name"
            },
            "adminDomainName" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 64,
                "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                "description" : "Admin domain name"
            },
            "password" : {
                "description" : "Admin password",
                "type" : "string"
            },
            "globalCatalogEnabled" : {
                "description" : "Global catalog support enabled or disabled",
                "type" : "boolean"
            },
            "mappings" : {
                "type" : "array",
                "description" : "Group attribute and user traffic profile mapping",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "description" : "User traffic profile mapping",
                    "properties" : {
                        "id" : {
                            "type" : "string",
                            "description" : "Group attribute mapping UUID"
                        },
                        "groupAttr" : {
                            "type" : "string",
                            "description" : "Group attribute"
                        },
                        "userRole" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "description" : "Identity user role",
                            "properties" : {
                                "id" : {
                                    "type" : "string",
                                    "description" : "Identity user role UUID"
                                },
                                "name" : {
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32,
                                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                    "description" : "Identity user role name"
                                },
                                "userTrafficProfile" : {
                                    "type" : "object",
                                    "description" : "Identity user role",
                                    "properties" : {
                                        "id" : {
                                            "type" : "string",
                                            "description" : "User traffic profile UUID"
                                        },
                                        "name" : {
                                            "type" : "string",
                                            "description" : "User traffic profile name"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "required" : [ "groupAttr", "userRole" ]
                }
            }
        }
    }
    
    

Create - Active Directory Authentication Service 

/v2_1/services/auth/ad

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

  • Request
  • Body
    {
        "name" : "rapheal-ad2",
        "ip" : "1.1.1.15",
        "port" : 389,
        "windowsDomainName" : "dc=domain",
        "globalCatalogEnabled" : false
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the active directory authentication service"
            },
            "friendlyName" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Friendly name of the active directory authentication service"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the active directory authentication service"
            },
            "ip" : {
                "type" : "string",
                "description" : "IP address"
            },
            "port" : {
                "description" : "Port",
                "type" : "integer",
                "minimum" : 1,
                "maximum" : 65535,
                "default" : 389
            },
            "windowsDomainName" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 64,
                "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                "description" : "Windows domain name"
            },
            "adminDomainName" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 64,
                "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                "description" : "Admin domain name"
            },
            "password" : {
                "description" : "Admin password",
                "type" : "string"
            },
            "globalCatalogEnabled" : {
                "description" : "Global catalog support enabled or disabled",
                "type" : "boolean"
            },
            "mappings" : {
                "type" : "array",
                "description" : "Group attribute and user traffic profile mapping",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "description" : "User traffic profile mapping",
                    "properties" : {
                        "groupAttr" : {
                            "type" : "string",
                            "description" : "Group attribute"
                        },
                        "userRole" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "description" : "Identity user role",
                            "properties" : {
                                "id" : {
                                    "type" : "string",
                                    "description" : "Identity user role UUID"
                                },
                                "name" : {
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32,
                                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                    "description" : "Identity user role name"
                                }
                            }
                        }
                    },
                    "required" : [ "groupAttr", "userRole" ]
                }
            }
        },
        "required" : [ "name", "ip", "port", "windowsDomainName", "globalCatalogEnabled" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "serviceUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Modify - Active Directory Authentication Service 

/v2_1/services/auth/ad/{id}

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

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

Modify - User Traffic Profile Mapping of Active Directory 

/v2_1/services/auth/ad/{id}/mappings

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

  • Request
  • Body
    [ {
        "groupAttr" : "newGroupAttr",
        "userRole" : {
            "id" : "identity user role UUID"
        }
    }, {
        "groupAttr" : "*",
        "userRole" : {
            "name" : "identity user role name"
        }
    } ]
    
    
    Schema
    {
        "type" : "array",
        "description" : "Group attribute and user traffic profile mapping",
        "items" : {
            "type" : "object",
            "additionalProperties" : false,
            "description" : "User traffic profile mapping",
            "properties" : {
                "groupAttr" : {
                    "type" : "string",
                    "description" : "Group attribute"
                },
                "userRole" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "description" : "Identity user role",
                    "properties" : {
                        "id" : {
                            "type" : "string",
                            "description" : "Identity user role UUID"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Identity user role name"
                        }
                    }
                }
            },
            "required" : [ "groupAttr", "userRole" ]
        }
    }
    
    
  • Response  204

Delete - Active Directory Authentication Service 

/v2_1/services/auth/ad/{id}

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

  • Response  204

Retrieve List - LDAP Authentication Service 

/v2_1/services/auth/ldap

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

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "18b76a50-6a57-11e4-96af-dc6020524153",
            "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
            "name" : "rapheal-ldap",
            "friendlyName" : "",
            "description" : "",
            "mappings" : [ {
                "id" : "afa788e0-6afd-11e4-b9bb-08002716c79f",
                "groupAttr" : "*",
                "userRole" : {
                    "id" : "636431d6-c06e-4692-a28f-3914afc2a817",
                    "name" : "identity user role name",
                    "userTrafficProfile" : {
                        "id" : "fbde8510-6972-11e4-926e-08002716c79f",
                        "name" : "System Default"
                    }
                }
            }, {
                "id" : "afaa4800-6afd-11e4-b9bb-08002716c79f",
                "groupAttr" : "abcd",
                "userRole" : {
                    "id" : "636431d6-c06e-4692-a28f-3914afc2a817",
                    "name" : "identity user role name",
                    "userTrafficProfile" : {
                        "id" : "fbde8510-6972-11e4-926e-08002716c79f",
                        "name" : "System Default"
                    }
                }
            } ],
            "ip" : "1.1.1.122",
            "port" : 389,
            "baseDomainName" : "dc=ldap",
            "adminDomainName" : "uid=ibm",
            "password" : "admin",
            "keyAttribute" : "uid",
            "searchFilter" : "(objectClass=*)"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the LDAP authentication service",
                            "type" : "string"
                        },
                        "mvnoId" : {
                            "description" : "Tenant UUID",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the LDAP authentication service"
                        },
                        "friendlyName" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Friendly name of the LDAP authentication service"
                        },
                        "description" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 64,
                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                            "description" : "Description of the LDAP authentication service"
                        },
                        "ip" : {
                            "type" : "string",
                            "description" : "IP address"
                        },
                        "port" : {
                            "description" : "Port",
                            "type" : "integer"
                        },
                        "baseDomainName" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 64,
                            "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                            "description" : "Base domain name"
                        },
                        "adminDomainName" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 64,
                            "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                            "description" : "Admin domain name"
                        },
                        "password" : {
                            "description" : "Admin password",
                            "type" : "string"
                        },
                        "keyAttribute" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 64,
                            "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                            "description" : "Key attribute"
                        },
                        "searchFilter" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 64,
                            "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                            "description" : "Search filter"
                        },
                        "mappings" : {
                            "type" : "array",
                            "description" : "Group attribute and user traffic profile mapping",
                            "items" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "description" : "User traffic profile mapping",
                                "properties" : {
                                    "id" : {
                                        "type" : "string",
                                        "description" : "Group attribute mapping UUID"
                                    },
                                    "groupAttr" : {
                                        "type" : "string",
                                        "description" : "Group attribute"
                                    },
                                    "userRole" : {
                                        "type" : "object",
                                        "additionalProperties" : false,
                                        "description" : "Identity user role",
                                        "properties" : {
                                            "id" : {
                                                "type" : "string",
                                                "description" : "Identity user role UUID"
                                            },
                                            "name" : {
                                                "type" : "string",
                                                "minLength" : 2,
                                                "maxLength" : 32,
                                                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                                "description" : "Identity user role name"
                                            },
                                            "userTrafficProfile" : {
                                                "type" : "object",
                                                "description" : "Identity user role",
                                                "properties" : {
                                                    "id" : {
                                                        "type" : "string",
                                                        "description" : "User traffic profile UUID"
                                                    },
                                                    "name" : {
                                                        "type" : "string",
                                                        "description" : "User traffic profile name"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "required" : [ "groupAttr", "userRole" ]
                            }
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve - LDAP Authentication Service 

/v2_1/services/auth/ldap/{id}

Use this API command to retrieve a LDAP authentication service.

  • Response  200
  • Body
    {
        "id" : "18b76a50-6a57-11e4-96af-dc6020524153",
        "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
        "name" : "rapheal-ldap",
        "friendlyName" : "",
        "description" : "",
        "mappings" : [ {
            "id" : "afa788e0-6afd-11e4-b9bb-08002716c79f",
            "groupAttr" : "*",
            "userRole" : {
                "id" : "636431d6-c06e-4692-a28f-3914afc2a817",
                "name" : "identity user role name",
                "userTrafficProfile" : {
                    "id" : "fbde8510-6972-11e4-926e-08002716c79f",
                    "name" : "System Default"
                }
            }
        }, {
            "id" : "afaa4800-6afd-11e4-b9bb-08002716c79f",
            "groupAttr" : "abcd",
            "userRole" : {
                "id" : "636431d6-c06e-4692-a28f-3914afc2a817",
                "name" : "identity user role name",
                "userTrafficProfile" : {
                    "id" : "fbde8510-6972-11e4-926e-08002716c79f",
                    "name" : "System Default"
                }
            }
        } ],
        "ip" : "1.1.1.122",
        "port" : 389,
        "baseDomainName" : "dc=ldap",
        "adminDomainName" : "uid=ibm",
        "password" : "admin",
        "keyAttribute" : "uid",
        "searchFilter" : "(objectClass=*)"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the LDAP authentication service",
                "type" : "string"
            },
            "mvnoId" : {
                "description" : "Tenant UUID",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the LDAP authentication service"
            },
            "friendlyName" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Friendly name of the LDAP authentication service"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the LDAP authentication service"
            },
            "ip" : {
                "type" : "string",
                "description" : "IP address"
            },
            "port" : {
                "description" : "Port",
                "type" : "integer"
            },
            "baseDomainName" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 64,
                "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                "description" : "Base domain name"
            },
            "adminDomainName" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 64,
                "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                "description" : "Admin domain name"
            },
            "password" : {
                "description" : "Admin password",
                "type" : "string"
            },
            "keyAttribute" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 64,
                "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                "description" : "Key attribute"
            },
            "searchFilter" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 64,
                "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                "description" : "Search filter"
            },
            "mappings" : {
                "type" : "array",
                "description" : "Group attribute and user traffic profile mapping",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "description" : "User traffic profile mapping",
                    "properties" : {
                        "id" : {
                            "type" : "string",
                            "description" : "Group attribute mapping UUID"
                        },
                        "groupAttr" : {
                            "type" : "string",
                            "description" : "Group attribute"
                        },
                        "userRole" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "description" : "Identity user role",
                            "properties" : {
                                "id" : {
                                    "type" : "string",
                                    "description" : "Identity user role UUID"
                                },
                                "name" : {
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32,
                                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                    "description" : "Identity user role name"
                                },
                                "userTrafficProfile" : {
                                    "type" : "object",
                                    "description" : "Identity user role",
                                    "properties" : {
                                        "id" : {
                                            "type" : "string",
                                            "description" : "User traffic profile UUID"
                                        },
                                        "name" : {
                                            "type" : "string",
                                            "description" : "User traffic profile name"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "required" : [ "groupAttr", "userRole" ]
                }
            }
        }
    }
    
    

Create - LDAP Authentication Service 

/v2_1/services/auth/ldap

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

  • Request
  • Body
    {
        "name" : "rapheal-ldap",
        "ip" : "1.1.1.1",
        "port" : 389,
        "baseDomainName" : "dc=ldap",
        "adminDomainName" : "uid=ibm",
        "password" : "admin",
        "keyAttribute" : "uid",
        "searchFilter" : "(objectClass=*)"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the LDAP authentication service"
            },
            "friendlyName" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Friendly name of the LDAP authentication service"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the LDAP authentication service"
            },
            "ip" : {
                "type" : "string",
                "description" : "IP address"
            },
            "port" : {
                "description" : "Port",
                "type" : "integer",
                "minimum" : 1,
                "maximum" : 65535,
                "default" : 389
            },
            "baseDomainName" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 64,
                "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                "description" : "Base domain name"
            },
            "adminDomainName" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 64,
                "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                "description" : "Admin domain name"
            },
            "password" : {
                "description" : "Admin password",
                "type" : "string"
            },
            "keyAttribute" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 64,
                "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                "description" : "Key attribute"
            },
            "searchFilter" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 64,
                "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
                "description" : "Search filter"
            },
            "mappings" : {
                "type" : "array",
                "description" : "Group attribute and user traffic profile mapping",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "description" : "User traffic profile mapping",
                    "properties" : {
                        "groupAttr" : {
                            "type" : "string",
                            "description" : "Group attribute"
                        },
                        "userRole" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "description" : "Identity user role",
                            "properties" : {
                                "id" : {
                                    "type" : "string",
                                    "description" : "Identity user role UUID"
                                },
                                "name" : {
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32,
                                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                    "description" : "Identity user role name"
                                }
                            }
                        }
                    },
                    "required" : [ "groupAttr", "userRole" ]
                }
            }
        },
        "required" : [ "name", "ip", "port", "baseDomainName", "adminDomainName", "password", "keyAttribute", "searchFilter" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "serviceUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Modify - LDAP Authentication Service 

/v2_1/services/auth/ldap/{id}

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

  • Request
  • Body
    {
        "friendlyName" : "new name",
        "description" : "new description"
    }
    
    
    Schema
    {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the LDAP authentication service"
        },
        "friendlyName" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Friendly name of the LDAP authentication service"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the LDAP authentication service"
        },
        "ip" : {
            "type" : "string",
            "description" : "IP address"
        },
        "port" : {
            "description" : "Port",
            "type" : "integer",
            "minimum" : 1,
            "maximum" : 65535,
            "default" : 389
        },
        "baseDomainName" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
            "description" : "Base domain name"
        },
        "adminDomainName" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
            "description" : "Admin domain name"
        },
        "password" : {
            "description" : "Admin password",
            "type" : "string"
        },
        "keyAttribute" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
            "description" : "Key attribute"
        },
        "searchFilter" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
            "description" : "Search filter"
        }
    }
    
    
  • Response  204

Modify - User Traffic Profile Mapping of LDAP 

/v2_1/services/auth/ldap/{id}/mappings

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

  • Request
  • Body
    [ {
        "groupAttr" : "newGroupAttr",
        "userRole" : {
            "id" : "identity user role UUID"
        }
    }, {
        "groupAttr" : "*",
        "userRole" : {
            "name" : "identity user role name"
        }
    } ]
    
    
    Schema
    {
        "type" : "array",
        "description" : "Group attribute and user traffic profile mapping",
        "items" : {
            "type" : "object",
            "additionalProperties" : false,
            "description" : "User traffic profile mapping",
            "properties" : {
                "groupAttr" : {
                    "type" : "string",
                    "description" : "Group attribute"
                },
                "userRole" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "description" : "Identity user role",
                    "properties" : {
                        "id" : {
                            "type" : "string",
                            "description" : "Identity user role UUID"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Identity user role name"
                        }
                    }
                }
            },
            "required" : [ "groupAttr", "userRole" ]
        }
    }
    
    
  • Response  204

Delete - LDAP Authentication Service 

/v2_1/services/auth/ldap/{id}

Use this API command to delete a LDAP authentication service.

  • Response  204

Retrieve List - OAuth Authentication Service 

/v2_1/services/auth/oauth

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

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "c74c5340-ac1b-11e4-8a77-08002716c79f",
            "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
            "name" : "globalOauth",
            "description" : "",
            "mappings" : [ {
                "id" : "c76bc220-ac1b-11e4-8a77-08002716c79f",
                "groupAttr" : "*",
                "userRole" : {
                    "id" : "ad0c58e3-acf7-42a2-a6a7-5a6216110906",
                    "name" : "Default",
                    "userTrafficProfile" : {
                        "id" : "f63a7ad0-8590-11e4-8051-08002716c79f",
                        "name" : "System Default"
                    }
                }
            } ],
            "type" : "FACEBOOK",
            "applicationId" : "test",
            "applicationSecret" : "test",
            "willCollectEmail" : true,
            "defaultWhitelistedDomains" : [ "fbcdn-profile-a.akamaihd.net", "fbstatic-a.akamaihd.net", "www.facebook.com" ],
            "whitelistedDomains" : [ "*.facebook.com", "ruckus.com" ]
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "oauthSpecifiedItems" : true,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the OAuth authentication service",
                            "type" : "string"
                        },
                        "type" : {
                            "description" : "OAuth Type, may be GOOGLE, FACEBOOK or LINKEDIN",
                            "enum" : [ "FACEBOOK", "GOOGLE", "LINKEDIN" ]
                        },
                        "mvnoId" : {
                            "description" : "Tenant UUID",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the OAuth authentication service"
                        },
                        "description" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 64,
                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                            "description" : "Description of the OAuth authentication service"
                        },
                        "applicationId" : {
                            "description" : "Application ID",
                            "type" : "string"
                        },
                        "applicationSecret" : {
                            "description" : "Application Secret",
                            "type" : "string"
                        },
                        "willCollectEmail" : {
                            "description" : "Will collect user's email address",
                            "type" : "boolean"
                        },
                        "defaultWhitelistedDomains" : {
                            "description" : "Defualt whitelisted domains",
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        },
                        "whitelistedDomains" : {
                            "description" : "Customized whitelisted domains",
                            "type" : "array",
                            "items" : {
                                "description" : "admin domain name",
                                "type" : "string"
                            }
                        },
                        "mappings" : {
                            "type" : "array",
                            "description" : "Group attribute and user traffic profile mapping",
                            "items" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "description" : "User traffic profile mapping",
                                "properties" : {
                                    "id" : {
                                        "type" : "string",
                                        "description" : "Group attribute mapping UUID"
                                    },
                                    "groupAttr" : {
                                        "type" : "string",
                                        "description" : "Group attribute"
                                    },
                                    "userRole" : {
                                        "type" : "object",
                                        "additionalProperties" : false,
                                        "description" : "Identity user role",
                                        "properties" : {
                                            "id" : {
                                                "type" : "string",
                                                "description" : "Identity user role UUID"
                                            },
                                            "name" : {
                                                "type" : "string",
                                                "minLength" : 2,
                                                "maxLength" : 32,
                                                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                                "description" : "Identity user role name"
                                            },
                                            "userTrafficProfile" : {
                                                "type" : "object",
                                                "description" : "Identity user role",
                                                "properties" : {
                                                    "id" : {
                                                        "type" : "string",
                                                        "description" : "User traffic profile UUID"
                                                    },
                                                    "name" : {
                                                        "type" : "string",
                                                        "description" : "User traffic profile name"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "required" : [ "groupAttr", "userRole" ]
                            }
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve - OAuth Authentication Service 

/v2_1/services/auth/oauth/{id}

Use this API command to retrieve a OAuth authentication service.

  • Response  200
  • Body
    {
        "id" : "c74c5340-ac1b-11e4-8a77-08002716c79f",
        "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
        "name" : "globalOauth",
        "description" : "",
        "mappings" : [ {
            "id" : "c76bc220-ac1b-11e4-8a77-08002716c79f",
            "groupAttr" : "*",
            "userRole" : {
                "id" : "ad0c58e3-acf7-42a2-a6a7-5a6216110906",
                "name" : "Default",
                "userTrafficProfile" : {
                    "id" : "f63a7ad0-8590-11e4-8051-08002716c79f",
                    "name" : "System Default"
                }
            }
        } ],
        "type" : "FACEBOOK",
        "applicationId" : "test",
        "applicationSecret" : "test",
        "willCollectEmail" : true,
        "defaultWhitelistedDomains" : [ "fbcdn-profile-a.akamaihd.net", "fbstatic-a.akamaihd.net", "*.facebook.com" ],
        "whitelistedDomains" : [ "ruckus.com" ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the OAuth authentication service",
                "type" : "string"
            },
            "type" : {
                "description" : "OAuth Type, may be GOOGLE, FACEBOOK or LINKEDIN",
                "enum" : [ "FACEBOOK", "GOOGLE", "LINKEDIN" ]
            },
            "mvnoId" : {
                "description" : "Tenant UUID",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the OAuth authentication service"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the OAuth authentication service"
            },
            "applicationId" : {
                "description" : "Application ID",
                "type" : "string"
            },
            "applicationSecret" : {
                "description" : "Application Secret",
                "type" : "string"
            },
            "willCollectEmail" : {
                "description" : "Will collect user's email address",
                "type" : "boolean"
            },
            "defaultWhitelistedDomains" : {
                "description" : "Defualt whitelisted domains",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "whitelistedDomains" : {
                "description" : "Customized whitelisted domains",
                "type" : "array",
                "items" : {
                    "description" : "admin domain name",
                    "type" : "string"
                }
            },
            "mappings" : {
                "type" : "array",
                "description" : "Group attribute and user traffic profile mapping",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "description" : "User traffic profile mapping",
                    "properties" : {
                        "id" : {
                            "type" : "string",
                            "description" : "Group attribute mapping UUID"
                        },
                        "groupAttr" : {
                            "type" : "string",
                            "description" : "Group attribute"
                        },
                        "userRole" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "description" : "Identity user role",
                            "properties" : {
                                "id" : {
                                    "type" : "string",
                                    "description" : "Identity user role UUID"
                                },
                                "name" : {
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32,
                                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                    "description" : "Identity user role name"
                                },
                                "userTrafficProfile" : {
                                    "type" : "object",
                                    "description" : "Identity user role",
                                    "properties" : {
                                        "id" : {
                                            "type" : "string",
                                            "description" : "User traffic profile UUID"
                                        },
                                        "name" : {
                                            "type" : "string",
                                            "description" : "User traffic profile name"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "required" : [ "groupAttr", "userRole" ]
                }
            }
        }
    }
    
    

Create - OAuth Authentication Service 

/v2_1/services/auth/oauth

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

  • Request
  • Body
    {
        "type" : "GOOGLE",
        "name" : "globalOauth",
        "description" : "",
        "mappings" : [ {
            "groupAttr" : "*",
            "userRole" : {
                "name" : "Default"
            }
        } ],
        "applicationId" : "test",
        "applicationSecret" : "test",
        "willCollectEmail" : true,
        "whitelistedDomains" : [ "ruckus.com" ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "type" : {
                "description" : "OAuth Type, may be GOOGLE, FACEBOOK or LINKEDIN",
                "enum" : [ "FACEBOOK", "GOOGLE", "LINKEDIN" ]
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the OAuth authentication service"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the OAuth authentication service"
            },
            "applicationId" : {
                "description" : "Application ID",
                "type" : "string"
            },
            "applicationSecret" : {
                "description" : "Application Secret",
                "type" : "string"
            },
            "willCollectEmail" : {
                "description" : "Will collect user's email address",
                "type" : "boolean"
            },
            "whitelistedDomains" : {
                "description" : "Admin domain name",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "mappings" : {
                "type" : "array",
                "description" : "Group attribute and user traffic profile mapping",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "description" : "User traffic profile mapping",
                    "properties" : {
                        "groupAttr" : {
                            "type" : "string",
                            "description" : "Group attribute"
                        },
                        "userRole" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "description" : "Identity user role",
                            "properties" : {
                                "id" : {
                                    "type" : "string",
                                    "description" : "Identity user role UUID"
                                },
                                "name" : {
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32,
                                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                    "description" : "Identity user role name"
                                }
                            }
                        }
                    },
                    "required" : [ "groupAttr", "userRole" ]
                }
            }
        },
        "required" : [ "type", "name", "applicationId", "applicationSecret", "willCollectEmail" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "serviceUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Modify - OAuth Authentication Service 

/v2_1/services/auth/oauth/{id}

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

  • Request
  • Body
    {
        "name" : "globalOauth",
        "description" : "",
        "applicationId" : "test",
        "applicationSecret" : "test",
        "willCollectEmail" : true
    }
    
    
    Schema
    {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the OAuth authentication service"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the OAuth authentication service"
        },
        "applicationId" : {
            "description" : "Application ID",
            "type" : "string"
        },
        "applicationSecret" : {
            "description" : "Application Secret",
            "type" : "string"
        },
        "willCollectEmail" : {
            "description" : "Will collect user's email address",
            "type" : "boolean"
        }
    }
    
    
  • Response  204

Modify - Whitelisted Domains of OAuth 

/v2_1/services/auth/oauth/{id}/whitelistedDomains

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

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

Modify - User Traffic Profile Mapping of OAuth 

/v2_1/services/auth/oauth/{id}/mappings

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

  • Request
  • Body
    [ {
        "groupAttr" : "*",
        "userRole" : {
            "name" : "Default"
        }
    } ]
    
    
    Schema
    {
        "type" : "array",
        "description" : "Group attribute and user traffic profile mapping",
        "items" : {
            "type" : "object",
            "additionalProperties" : false,
            "description" : "User traffic profile mapping",
            "properties" : {
                "groupAttr" : {
                    "type" : "string",
                    "description" : "Group attribute"
                },
                "userRole" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "description" : "Identity user role",
                    "properties" : {
                        "id" : {
                            "type" : "string",
                            "description" : "Identity user role UUID"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Identity user role name"
                        }
                    }
                }
            },
            "required" : [ "groupAttr", "userRole" ]
        }
    }
    
    
  • Response  204

Delete - OAuth Authentication Service 

/v2_1/services/auth/oauth/{id}

Use this API command to delete an OAuth authentication service.

  • Response  204

Accounting Service 

Retrieve List - RADIUS Accounting Service 

/v2_1/services/acct/radius

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

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "accountingServiceUUID",
            "mvnoId" : "userMVNOId",
            "name" : "accountingServiceName",
            "description" : "accountingServiceDescription",
            "primary" : {
                "ip" : "192.168.1.1",
                "port" : 1812,
                "sharedSecret" : "sharedSecret"
            },
            "secondary" : {
                "ip" : "192.168.1.2",
                "port" : 1812,
                "sharedSecret" : "sharedSecret"
            },
            "healthCheckPolicy" : {
                "responseWindow" : 20,
                "reviveInterval" : 120,
                "zombiePeriod" : 40
            },
            "rateLimiting" : {
                "maxOutstandingRequestsPerServer" : 0,
                "threshold" : 0,
                "sanityTimer" : 10
            }
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the RADIUS accounting service",
                            "type" : "string"
                        },
                        "mvnoId" : {
                            "description" : "Tenant UUID",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the RADIUS accounting service"
                        },
                        "description" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 64,
                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                            "description" : "Description of the RADIUS accounting service"
                        },
                        "primary" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "ip" : {
                                    "type" : "string",
                                    "description" : "Server IP"
                                },
                                "port" : {
                                    "description" : "Server port",
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                },
                                "sharedSecret" : {
                                    "description" : "Server shared secrect",
                                    "type" : "string"
                                }
                            },
                            "required" : [ "ip", "port", "sharedSecret" ],
                            "description" : "Primary RADIUS server"
                        },
                        "secondary" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "autoFallbackDisable" : {
                                    "descriptin" : "Automatic fallback enabled or disabled",
                                    "type" : "boolean"
                                },
                                "ip" : {
                                    "type" : "string",
                                    "description" : "RADIUS server IP"
                                },
                                "port" : {
                                    "description" : "RADIUS server port",
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 1812
                                },
                                "sharedSecret" : {
                                    "description" : "RADIUS server shared secrect",
                                    "type" : "string"
                                }
                            },
                            "required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
                            "description" : "Secondary RADIUS server"
                        },
                        "healthCheckPolicy" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "responseWindow" : {
                                    "description" : "Response window",
                                    "type" : "integer",
                                    "minimum" : 5,
                                    "maximum" : 30,
                                    "default" : 20
                                },
                                "reviveInterval" : {
                                    "description" : "Revive interval",
                                    "type" : "integer",
                                    "minimum" : 60,
                                    "maximum" : 3600,
                                    "default" : 120
                                },
                                "zombiePeriod" : {
                                    "description" : "Zombie period",
                                    "type" : "integer",
                                    "minimum" : 30,
                                    "maximum" : 120,
                                    "default" : 40
                                }
                            },
                            "required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
                            "description" : "Health check policy"
                        },
                        "rateLimiting" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "maxOutstandingRequestsPerServer" : {
                                    "description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
                                    "type" : "integer",
                                    "default" : 0
                                },
                                "threshold" : {
                                    "description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
                                    "type" : "integer",
                                    "default" : 0
                                },
                                "sanityTimer" : {
                                    "description" : "Sanity timer ",
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 3600,
                                    "default" : 10
                                }
                            },
                            "required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
                            "description" : "Rate limiting"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve - RADIUS Accounting Service 

/v2_1/services/acct/radius/{id}

Use this API command to retrieve a RADIUS accounting service.

  • Response  200
  • Body
    {
        "id" : "accountingServiceUUID",
        "mvnoId" : "userMVNOId",
        "name" : "accountingServiceName",
        "description" : "accountingServiceDescription",
        "primary" : {
            "ip" : "192.168.1.1",
            "port" : 1812,
            "sharedSecret" : "sharedSecret"
        },
        "secondary" : {
            "ip" : "192.168.1.2",
            "port" : 1812,
            "sharedSecret" : "sharedSecret"
        },
        "healthCheckPolicy" : {
            "responseWindow" : 20,
            "reviveInterval" : 120,
            "zombiePeriod" : 40
        },
        "rateLimiting" : {
            "maxOutstandingRequestsPerServer" : 0,
            "threshold" : 0,
            "sanityTimer" : 10
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the RADIUS accounting service",
                "type" : "string"
            },
            "mvnoId" : {
                "description" : "Tenant UUID",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the RADIUS accounting service"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the RADIUS accounting service"
            },
            "primary" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "ip" : {
                        "type" : "string",
                        "description" : "Server IP"
                    },
                    "port" : {
                        "description" : "Server port",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 65535
                    },
                    "sharedSecret" : {
                        "description" : "Server shared secrect",
                        "type" : "string"
                    }
                },
                "required" : [ "ip", "port", "sharedSecret" ],
                "description" : "Primary RADIUS server"
            },
            "secondary" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "autoFallbackDisable" : {
                        "descriptin" : "Automatic fallback enabled or disabled",
                        "type" : "boolean"
                    },
                    "ip" : {
                        "type" : "string",
                        "description" : "RADIUS server IP"
                    },
                    "port" : {
                        "description" : "RADIUS server port",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 65535,
                        "default" : 1812
                    },
                    "sharedSecret" : {
                        "description" : "RADIUS server shared secrect",
                        "type" : "string"
                    }
                },
                "required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
                "description" : "Secondary RADIUS server"
            },
            "healthCheckPolicy" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "responseWindow" : {
                        "description" : "Response window",
                        "type" : "integer",
                        "minimum" : 5,
                        "maximum" : 30,
                        "default" : 20
                    },
                    "reviveInterval" : {
                        "description" : "Revive interval",
                        "type" : "integer",
                        "minimum" : 60,
                        "maximum" : 3600,
                        "default" : 120
                    },
                    "zombiePeriod" : {
                        "description" : "Zombie period",
                        "type" : "integer",
                        "minimum" : 30,
                        "maximum" : 120,
                        "default" : 40
                    }
                },
                "required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
                "description" : "Health check policy"
            },
            "rateLimiting" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "maxOutstandingRequestsPerServer" : {
                        "description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
                        "type" : "integer",
                        "default" : 0
                    },
                    "threshold" : {
                        "description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
                        "type" : "integer",
                        "default" : 0
                    },
                    "sanityTimer" : {
                        "description" : "Sanity timer ",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 3600,
                        "default" : 10
                    }
                },
                "required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
                "description" : "Rate limiting"
            }
        }
    }
    
    

Create - RADIUS Accounting Service 

/v2_1/services/acct/radius

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

  • Request
  • Body
    {
        "name" : "accountingServiceName",
        "primary" : {
            "ip" : "192.168.1.1",
            "port" : 1813,
            "sharedSecret" : "sharedSecret"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the RADIUS accounting service"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the RADIUS accounting service"
            },
            "primary" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "ip" : {
                        "type" : "string",
                        "description" : "Server IP"
                    },
                    "port" : {
                        "description" : "Server port",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 65535
                    },
                    "sharedSecret" : {
                        "description" : "Server shared secrect",
                        "type" : "string"
                    }
                },
                "required" : [ "ip", "port", "sharedSecret" ],
                "description" : "Primary RADIUS server"
            },
            "secondary" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "autoFallbackDisable" : {
                        "descriptin" : "Automatic fallback enabled or disabled",
                        "type" : "boolean"
                    },
                    "ip" : {
                        "type" : "string",
                        "description" : "RADIUS server IP"
                    },
                    "port" : {
                        "description" : "RADIUS server port",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 65535,
                        "default" : 1812
                    },
                    "sharedSecret" : {
                        "description" : "RADIUS server shared secrect",
                        "type" : "string"
                    }
                },
                "required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
                "description" : "Secondary RADIUS server"
            },
            "healthCheckPolicy" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "responseWindow" : {
                        "description" : "Response window",
                        "type" : "integer",
                        "minimum" : 5,
                        "maximum" : 30,
                        "default" : 20
                    },
                    "reviveInterval" : {
                        "description" : "Revive interval",
                        "type" : "integer",
                        "minimum" : 60,
                        "maximum" : 3600,
                        "default" : 120
                    },
                    "zombiePeriod" : {
                        "description" : "Zombie period",
                        "type" : "integer",
                        "minimum" : 30,
                        "maximum" : 120,
                        "default" : 40
                    }
                },
                "required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
                "description" : "Health check policy"
            },
            "rateLimiting" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "maxOutstandingRequestsPerServer" : {
                        "description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
                        "type" : "integer",
                        "default" : 0
                    },
                    "threshold" : {
                        "description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
                        "type" : "integer",
                        "default" : 0
                    },
                    "sanityTimer" : {
                        "description" : "Sanity timer ",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 3600,
                        "default" : 10
                    }
                },
                "required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
                "description" : "Rate limiting"
            }
        },
        "required" : [ "name", "primary" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "serviceUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Modify - RADIUS Accounting Service 

/v2_1/services/acct/radius/{id}

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

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

Modify - Primary RADIUS Server of Accounting Service 

/v2_1/services/acct/radius/{id}/primary

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

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

Modify - Secondary RADIUS Server of Accounting Service 

/v2_1/services/acct/radius/{id}/secondary

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

  • Request
  • Body
    {
        "ip" : "192.168.1.2",
        "port" : 1812,
        "sharedSecret" : "sharedSecret"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "autoFallbackDisable" : {
                "descriptin" : "Automatic fallback enabled or disabled",
                "type" : "boolean"
            },
            "ip" : {
                "type" : "string",
                "description" : "RADIUS server IP"
            },
            "port" : {
                "description" : "RADIUS server port",
                "type" : "integer",
                "minimum" : 1,
                "maximum" : 65535,
                "default" : 1812
            },
            "sharedSecret" : {
                "description" : "RADIUS server shared secrect",
                "type" : "string"
            }
        },
        "required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
        "description" : "Secondary RADIUS server"
    }
    
    
  • Response  204

Modify - Rate Limiting of Accounting Service 

/v2_1/services/acct/radius/{id}/rateLimiting

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

  • Request
  • Body
    {
        "maxOutstandingRequestsPerServer" : 0,
        "threshold" : 0,
        "sanityTimer" : 10
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "maxOutstandingRequestsPerServer" : {
                "description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
                "type" : "integer",
                "default" : 0
            },
            "threshold" : {
                "description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
                "type" : "integer",
                "default" : 0
            },
            "sanityTimer" : {
                "description" : "Sanity timer ",
                "type" : "integer",
                "minimum" : 1,
                "maximum" : 3600,
                "default" : 10
            }
        },
        "required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
        "description" : "Rate limiting"
    }
    
    
  • Response  204

Modify - Health Check Policy of Accounting Service 

/v2_1/services/acct/radius/{id}/healthCheckPolicy

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

  • Request
  • Body
    {
        "responseWindow" : 20,
        "reviveInterval" : 120,
        "zombiePeriod" : 40
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "responseWindow" : {
                "description" : "Response window",
                "type" : "integer",
                "minimum" : 5,
                "maximum" : 30,
                "default" : 20
            },
            "reviveInterval" : {
                "description" : "Revive interval",
                "type" : "integer",
                "minimum" : 60,
                "maximum" : 3600,
                "default" : 120
            },
            "zombiePeriod" : {
                "description" : "Zombie period",
                "type" : "integer",
                "minimum" : 30,
                "maximum" : 120,
                "default" : 40
            }
        },
        "required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
        "description" : "Health check policy"
    }
    
    
  • Response  204

Disable Secondary RADIUS Server of Accounting Service 

/v2_1/services/acct/radius/{id}/secondary

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

  • Response  204

Delete - RADIUS Accounting Service 

/v2_1/services/acct/radius/{id}

Use this API command to delete a RADIUS accounting service.

  • Response  204

Authentication Profile 

Retrieve List 

/v2_1/profiles/auth

Use this API command to retrieve a list of authentication profiles.

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "5f154cd0-6f91-11e4-9984-068020524153",
            "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
            "name" : "authenticationProfileName",
            "description" : null,
            "gppSuppportEnabled" : true,
            "aaaSuppportEnabled" : true,
            "ttgCommonSetting" : {
                "interimAcctInterval" : 600,
                "sessionTimeout" : 22,
                "sessionIdleTimeout" : 120,
                "mobileCountryCode" : "086",
                "mobileNetworkCode" : "010"
            },
            "realmMappings" : [ {
                "realm" : "No Match",
                "id" : null,
                "name" : null,
                "dynamicVlanId" : null,
                "serviceType" : "NA",
                "authorizationMethod" : "NonGPPCallFlow"
            }, {
                "realm" : "Unspecified",
                "id" : null,
                "name" : null,
                "dynamicVlanId" : null,
                "serviceType" : "NA",
                "authorizationMethod" : "NonGPPCallFlow"
            } ]
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication profile",
                            "type" : "string"
                        },
                        "mvnoId" : {
                            "description" : "Tenant UUID",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the authentication profile"
                        },
                        "description" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 64,
                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                            "description" : "Description of the authentication profile"
                        },
                        "gppSuppportEnabled" : {
                            "description" : "3GPP support enabled or disabled",
                            "type" : "boolean"
                        },
                        "aaaSuppportEnabled" : {
                            "description" : "Hosted AAA support enabled or disabled",
                            "type" : "boolean"
                        },
                        "ttgCommonSetting" : {
                            "type" : "object",
                            "description" : "Hosted AAA server RADIUS settings & PLMN ID settings",
                            "properties" : {
                                "interimAcctInterval" : {
                                    "type" : "integer",
                                    "description" : "Interim accounting interval (value should be 0 or 600~65536, unit: seconds)"
                                },
                                "sessionTimeout" : {
                                    "type" : "integer",
                                    "description" : "Session timeout (unit: seconds)",
                                    "minimum" : 0,
                                    "maximum" : 2147483647,
                                    "default" : 0
                                },
                                "sessionIdleTimeout" : {
                                    "type" : "integer",
                                    "description" : "Session idle timeout (unit: seconds)",
                                    "minimum" : 90,
                                    "maximum" : 600,
                                    "default" : 120
                                },
                                "mobileCountryCode" : {
                                    "type" : "string",
                                    "description" : "Mobile country code",
                                    "minLength" : 3,
                                    "maxLength" : 3,
                                    "pattern" : "[0-9]+"
                                },
                                "mobileNetworkCode" : {
                                    "type" : "string",
                                    "description" : "Mobile network code",
                                    "minLength" : 2,
                                    "maxLength" : 3,
                                    "pattern" : "[0-9]+"
                                }
                            }
                        },
                        "realmMappings" : {
                            "type" : "array",
                            "description" : "Realm based authentication service mappings",
                            "items" : {
                                "type" : "object",
                                "description" : "Realm based authentication service mappings",
                                "additionalProperties" : false,
                                "properties" : {
                                    "realm" : {
                                        "type" : "string",
                                        "maxLength" : 255,
                                        "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                        "description" : "Realm"
                                    },
                                    "serviceType" : {
                                        "description" : "Authentication service type, NA is NA-Request Rejected",
                                        "enum" : [ "NA", "RADIUS", "LOCAL_DB", "HLR" ]
                                    },
                                    "id" : {
                                        "type" : [ "string", "null" ],
                                        "description" : "Authentication service UUID"
                                    },
                                    "name" : {
                                        "type" : [ "string", "null" ],
                                        "description" : "Authentication service name"
                                    },
                                    "authorizationMethod" : {
                                        "description" : "Authorization method",
                                        "enum" : [ "NonGPPCallFlow", "GPPCallFlow", "UpdateGPRSLocation", "RestoreData", "NoAutz" ]
                                    },
                                    "dynamicVlanId" : {
                                        "type" : [ "integer", "null" ],
                                        "description" : "Dynamic VLAN ID",
                                        "minimum" : 2,
                                        "maximum" : 4094
                                    }
                                },
                                "required" : [ "realm", "serviceType", "authorizationMethod" ]
                            }
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve 

/v2_1/profiles/auth/{id}

Use this API command to retrieve an authentication profile.

  • Response  200
  • Body
    {
        "id" : "5f154cd0-6f91-11e4-9984-068020524153",
        "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
        "name" : "authenticationProfileName",
        "description" : null,
        "gppSuppportEnabled" : true,
        "aaaSuppportEnabled" : true,
        "ttgCommonSetting" : {
            "interimAcctInterval" : 600,
            "sessionTimeout" : 22,
            "sessionIdleTimeout" : 120,
            "mobileCountryCode" : "086",
            "mobileNetworkCode" : "010"
        },
        "realmMappings" : [ {
            "realm" : "No Match",
            "id" : null,
            "name" : null,
            "dynamicVlanId" : null,
            "serviceType" : "NA",
            "authorizationMethod" : "NonGPPCallFlow"
        }, {
            "realm" : "Unspecified",
            "id" : null,
            "name" : null,
            "dynamicVlanId" : null,
            "serviceType" : "NA",
            "authorizationMethod" : "NonGPPCallFlow"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the authentication profile",
                "type" : "string"
            },
            "mvnoId" : {
                "description" : "Tenant UUID",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the authentication profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the authentication profile"
            },
            "gppSuppportEnabled" : {
                "description" : "3GPP support enabled or disabled",
                "type" : "boolean"
            },
            "aaaSuppportEnabled" : {
                "description" : "Hosted AAA support enabled or disabled",
                "type" : "boolean"
            },
            "ttgCommonSetting" : {
                "type" : "object",
                "description" : "Hosted AAA server RADIUS settings & PLMN ID settings",
                "properties" : {
                    "interimAcctInterval" : {
                        "type" : "integer",
                        "description" : "Interim accounting interval (value should be 0 or 600~65536, unit: seconds)"
                    },
                    "sessionTimeout" : {
                        "type" : "integer",
                        "description" : "Session timeout (unit: seconds)",
                        "minimum" : 0,
                        "maximum" : 2147483647,
                        "default" : 0
                    },
                    "sessionIdleTimeout" : {
                        "type" : "integer",
                        "description" : "Session idle timeout (unit: seconds)",
                        "minimum" : 90,
                        "maximum" : 600,
                        "default" : 120
                    },
                    "mobileCountryCode" : {
                        "type" : "string",
                        "description" : "Mobile country code",
                        "minLength" : 3,
                        "maxLength" : 3,
                        "pattern" : "[0-9]+"
                    },
                    "mobileNetworkCode" : {
                        "type" : "string",
                        "description" : "Mobile network code",
                        "minLength" : 2,
                        "maxLength" : 3,
                        "pattern" : "[0-9]+"
                    }
                }
            },
            "realmMappings" : {
                "type" : "array",
                "description" : "Realm based authentication service mappings",
                "items" : {
                    "type" : "object",
                    "description" : "Realm based authentication service mappings",
                    "additionalProperties" : false,
                    "properties" : {
                        "realm" : {
                            "type" : "string",
                            "maxLength" : 255,
                            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                            "description" : "Realm"
                        },
                        "serviceType" : {
                            "description" : "Authentication service type, NA is NA-Request Rejected",
                            "enum" : [ "NA", "RADIUS", "LOCAL_DB", "HLR" ]
                        },
                        "id" : {
                            "type" : [ "string", "null" ],
                            "description" : "Authentication service UUID"
                        },
                        "name" : {
                            "type" : [ "string", "null" ],
                            "description" : "Authentication service name"
                        },
                        "authorizationMethod" : {
                            "description" : "Authorization method",
                            "enum" : [ "NonGPPCallFlow", "GPPCallFlow", "UpdateGPRSLocation", "RestoreData", "NoAutz" ]
                        },
                        "dynamicVlanId" : {
                            "type" : [ "integer", "null" ],
                            "description" : "Dynamic VLAN ID",
                            "minimum" : 2,
                            "maximum" : 4094
                        }
                    },
                    "required" : [ "realm", "serviceType", "authorizationMethod" ]
                }
            }
        }
    }
    
    

Create 

/v2_1/profiles/auth

Use this API command to create a new authentication profile.

  • Request
  • Body
    {
        "name" : "authenticationProfileName",
        "gppSuppportEnabled" : false,
        "aaaSuppportEnabled" : false
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the authentication profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the authentication profile"
            },
            "gppSuppportEnabled" : {
                "description" : "3GPP support enabled or disabled",
                "type" : "boolean",
                "default" : false
            },
            "aaaSuppportEnabled" : {
                "description" : "Hosted AAA support enabled or disabled",
                "type" : "boolean",
                "default" : false
            },
            "ttgCommonSetting" : {
                "type" : "object",
                "description" : "Hosted AAA server RADIUS settings & PLMN ID settings",
                "properties" : {
                    "interimAcctInterval" : {
                        "type" : "integer",
                        "description" : "Interim accounting interval (value should be 0 or 600~65536, unit: seconds)"
                    },
                    "sessionTimeout" : {
                        "type" : "integer",
                        "description" : "Session timeout (unit: seconds)",
                        "minimum" : 0,
                        "maximum" : 2147483647,
                        "default" : 0
                    },
                    "sessionIdleTimeout" : {
                        "type" : "integer",
                        "description" : "Session idle timeout (unit: seconds)",
                        "minimum" : 90,
                        "maximum" : 600,
                        "default" : 120
                    },
                    "mobileCountryCode" : {
                        "type" : "string",
                        "description" : "Mobile country code",
                        "minLength" : 3,
                        "maxLength" : 3,
                        "pattern" : "[0-9]+"
                    },
                    "mobileNetworkCode" : {
                        "type" : "string",
                        "description" : "Mobile network code",
                        "minLength" : 2,
                        "maxLength" : 3,
                        "pattern" : "[0-9]+"
                    }
                }
            },
            "realmMappings" : {
                "type" : "array",
                "description" : "Realm based authentication service mappings",
                "items" : {
                    "type" : "object",
                    "description" : "Realm based authentication service mappings",
                    "additionalProperties" : false,
                    "properties" : {
                        "realm" : {
                            "type" : "string",
                            "maxLength" : 255,
                            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                            "description" : "Realm"
                        },
                        "serviceType" : {
                            "description" : "Authentication service type, NA is NA-Request Rejected",
                            "enum" : [ "NA", "RADIUS", "LOCAL_DB", "HLR" ]
                        },
                        "id" : {
                            "type" : [ "string", "null" ],
                            "description" : "Authentication service UUID"
                        },
                        "name" : {
                            "type" : [ "string", "null" ],
                            "description" : "Authentication service name"
                        },
                        "authorizationMethod" : {
                            "description" : "Authorization method",
                            "enum" : [ "NonGPPCallFlow", "GPPCallFlow", "UpdateGPRSLocation", "RestoreData", "NoAutz" ]
                        },
                        "dynamicVlanId" : {
                            "type" : [ "integer", "null" ],
                            "description" : "Dynamic VLAN ID",
                            "minimum" : 2,
                            "maximum" : 4094
                        }
                    },
                    "required" : [ "realm", "serviceType", "authorizationMethod" ]
                }
            }
        },
        "required" : [ "name", "gppSuppportEnabled", "aaaSuppportEnabled" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "profileUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v2_1/profiles/auth/{id}

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

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

Modify 3GPP Common Settings 

/v2_1/profiles/auth/{id}/ttgCommonSetting

Use this API command to modify 3GPP common settings of an authentication profile.

  • Request
  • Body
    {
        "interimAcctInterval" : 600,
        "sessionTimeout" : 0,
        "sessionIdleTimeout" : 120,
        "mobileCountryCode" : "086",
        "mobileNetworkCode" : "010"
    }
    
    
    Schema
    {
        "type" : "object",
        "description" : "Hosted AAA server RADIUS settings & PLMN ID settings",
        "properties" : {
            "interimAcctInterval" : {
                "type" : "integer",
                "description" : "Interim accounting interval (value should be 0 or 600~65536, unit: seconds)"
            },
            "sessionTimeout" : {
                "type" : "integer",
                "description" : "Session timeout (unit: seconds)",
                "minimum" : 0,
                "maximum" : 2147483647,
                "default" : 0
            },
            "sessionIdleTimeout" : {
                "type" : "integer",
                "description" : "Session idle timeout (unit: seconds)",
                "minimum" : 90,
                "maximum" : 600,
                "default" : 120
            },
            "mobileCountryCode" : {
                "type" : "string",
                "description" : "Mobile country code",
                "minLength" : 3,
                "maxLength" : 3,
                "pattern" : "[0-9]+"
            },
            "mobileNetworkCode" : {
                "type" : "string",
                "description" : "Mobile network code",
                "minLength" : 2,
                "maxLength" : 3,
                "pattern" : "[0-9]+"
            }
        }
    }
    
    
  • Response  204

Modify Realm Mappings 

/v2_1/profiles/auth/{id}/realmMappings

Use this API command to modify realm based authentication service mappings of an authentication profile.

  • Request
  • Body
    [ {
        "realm" : "No Match",
        "serviceType" : "LOCAL_DB",
        "authorizationMethod" : "NonGPPCallFlow"
    }, {
        "realm" : "Unspecified",
        "id" : "00f6f020-7470-11e4-afe9-08002716c79f",
        "name" : "auth service",
        "serviceType" : "RADIUS",
        "authorizationMethod" : "GPPCallFlow"
    } ]
    
    
    Schema
    {
        "type" : "array",
        "description" : "Realm based authentication service mappings",
        "items" : {
            "type" : "object",
            "description" : "Realm based authentication service mappings",
            "additionalProperties" : false,
            "properties" : {
                "realm" : {
                    "type" : "string",
                    "maxLength" : 255,
                    "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                    "description" : "Realm"
                },
                "serviceType" : {
                    "description" : "Authentication service type, NA is NA-Request Rejected",
                    "enum" : [ "NA", "RADIUS", "LOCAL_DB", "HLR" ]
                },
                "id" : {
                    "type" : [ "string", "null" ],
                    "description" : "Authentication service UUID"
                },
                "name" : {
                    "type" : [ "string", "null" ],
                    "description" : "Authentication service name"
                },
                "authorizationMethod" : {
                    "description" : "Authorization method",
                    "enum" : [ "NonGPPCallFlow", "GPPCallFlow", "UpdateGPRSLocation", "RestoreData", "NoAutz" ]
                },
                "dynamicVlanId" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Dynamic VLAN ID",
                    "minimum" : 2,
                    "maximum" : 4094
                }
            },
            "required" : [ "realm", "serviceType", "authorizationMethod" ]
        }
    }
    
    
  • Response  204

Delete 

/v2_1/profiles/auth/{id}

Use this API command to delete an authentication profile.

  • Response  204

Accounting Profile 

Retrieve List 

/v2_1/profiles/acct

Use this API command to retrieve a list of accounting profiles.

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
            "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
            "name" : "new name",
            "description" : "new description",
            "realmMappings" : [ {
                "realm" : "realm",
                "id" : "78585bb0-7126-11e4-a730-0800276fe6ca",
                "name" : "acct service",
                "serviceType" : "RADIUS"
            }, {
                "realm" : "No Match",
                "id" : "78585bb0-7126-11e4-a730-0800276fe6ca",
                "name" : "acct service",
                "serviceType" : "RADIUS"
            }, {
                "realm" : "Unspecified",
                "id" : null,
                "name" : null,
                "serviceType" : "NA"
            } ]
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the accounting profile",
                            "type" : "string"
                        },
                        "mvnoId" : {
                            "description" : "Tenant UUID",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the accounting profile"
                        },
                        "description" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 64,
                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                            "description" : "Description of the accounting profile"
                        },
                        "realmMappings" : {
                            "type" : "array",
                            "description" : "Accounting service per realm",
                            "items" : {
                                "type" : "object",
                                "description" : "Accounting service per realm",
                                "additionalProperties" : false,
                                "properties" : {
                                    "realm" : {
                                        "type" : "string",
                                        "maxLength" : 255,
                                        "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                        "description" : "Realm"
                                    },
                                    "serviceType" : {
                                        "description" : "Accounting service type, NA is NA-Request Rejected",
                                        "enum" : [ "NA", "RADIUS", "CGF" ]
                                    },
                                    "id" : {
                                        "type" : [ "string", "null" ],
                                        "description" : "Accounting service UUID"
                                    },
                                    "name" : {
                                        "type" : [ "string", "null" ],
                                        "description" : "Accounting service name"
                                    }
                                },
                                "required" : [ "realm", "serviceType" ]
                            }
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve 

/v2_1/profiles/acct/{id}

Use this API command to retrieve an accounting profile.

  • Response  200
  • Body
    {
        "id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
        "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
        "name" : "new name",
        "description" : "new description",
        "realmMappings" : [ {
            "realm" : "realm",
            "id" : "78585bb0-7126-11e4-a730-0800276fe6ca",
            "name" : "acct service",
            "serviceType" : "RADIUS"
        }, {
            "realm" : "No Match",
            "id" : "78585bb0-7126-11e4-a730-0800276fe6ca",
            "name" : "acct service",
            "serviceType" : "RADIUS"
        }, {
            "realm" : "Unspecified",
            "id" : null,
            "name" : null,
            "serviceType" : "NA"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the accounting profile",
                "type" : "string"
            },
            "mvnoId" : {
                "description" : "Tenant UUID",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the accounting profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the accounting profile"
            },
            "realmMappings" : {
                "type" : "array",
                "description" : "Accounting service per realm",
                "items" : {
                    "type" : "object",
                    "description" : "Accounting service per realm",
                    "additionalProperties" : false,
                    "properties" : {
                        "realm" : {
                            "type" : "string",
                            "maxLength" : 255,
                            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                            "description" : "Realm"
                        },
                        "serviceType" : {
                            "description" : "Accounting service type, NA is NA-Request Rejected",
                            "enum" : [ "NA", "RADIUS", "CGF" ]
                        },
                        "id" : {
                            "type" : [ "string", "null" ],
                            "description" : "Accounting service UUID"
                        },
                        "name" : {
                            "type" : [ "string", "null" ],
                            "description" : "Accounting service name"
                        }
                    },
                    "required" : [ "realm", "serviceType" ]
                }
            }
        }
    }
    
    

Create 

/v2_1/profiles/acct

Use this API command to create a new accounting profile.

  • Request
  • Body
    {
        "name" : "accountingProfileName"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the accounting profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the accounting profile"
            },
            "realmMappings" : {
                "type" : "array",
                "description" : "Accounting service per realm",
                "items" : {
                    "type" : "object",
                    "description" : "Accounting service per realm",
                    "additionalProperties" : false,
                    "properties" : {
                        "realm" : {
                            "type" : "string",
                            "maxLength" : 255,
                            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                            "description" : "Realm"
                        },
                        "serviceType" : {
                            "description" : "Accounting service type, NA is NA-Request Rejected",
                            "enum" : [ "NA", "RADIUS", "CGF" ]
                        },
                        "id" : {
                            "type" : [ "string", "null" ],
                            "description" : "Accounting service UUID"
                        },
                        "name" : {
                            "type" : [ "string", "null" ],
                            "description" : "Accounting service name"
                        }
                    },
                    "required" : [ "realm", "serviceType" ]
                }
            }
        },
        "required" : [ "name" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "profileUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v2_1/profiles/acct/{id}

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

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

Modify Realm Mappings 

/v2_1/profiles/acct/{id}/realmMappings

Use this API command to modify accounting service per realm mappings of an accounting profile.

  • Request
  • Body
    [ {
        "realm" : "realm",
        "id" : "78585bb0-7126-11e4-a730-0800276fe6ca",
        "serviceType" : "RADIUS"
    }, {
        "realm" : "No Match",
        "name" : "acct service",
        "serviceType" : "RADIUS"
    }, {
        "realm" : "Unspecified",
        "id" : null,
        "name" : null,
        "serviceType" : "NA"
    } ]
    
    
    Schema
    {
        "type" : "array",
        "description" : "Accounting service per realm",
        "items" : {
            "type" : "object",
            "description" : "Accounting service per realm",
            "additionalProperties" : false,
            "properties" : {
                "realm" : {
                    "type" : "string",
                    "maxLength" : 255,
                    "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                    "description" : "Realm"
                },
                "serviceType" : {
                    "description" : "Accounting service type, NA is NA-Request Rejected",
                    "enum" : [ "NA", "RADIUS", "CGF" ]
                },
                "id" : {
                    "type" : [ "string", "null" ],
                    "description" : "Accounting service UUID"
                },
                "name" : {
                    "type" : [ "string", "null" ],
                    "description" : "Accounting service name"
                }
            },
            "required" : [ "realm", "serviceType" ]
        }
    }
    
    
  • Response  204

Delete 

/v2_1/profiles/acct/{id}

Use this API command to delete an accounting profile.

  • Response  204

Hotspot Profile 

Retrieve List 

/v2_1/profiles/hotspot

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

  • Response  200
  • Body
    {
        "totalCount" : 1,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
            "name" : "new name"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the profile",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the profile"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve 

/v2_1/profiles/hotspot/{id}

Use this API command to retrieve a Hotspot profile.

  • Response  200
  • Body
    {
        "name" : "hotspot profile internal",
        "id" : "aed0c0b7-5358-465f-8091-fa0f26134d53",
        "description" : "hotspot profile internal description",
        "smartClientSupport" : "None",
        "smartClientInfo" : null,
        "portalType" : "Internal",
        "portalUrl" : null,
        "redirect" : null,
        "userSession" : {
            "timeoutInMin" : 1440,
            "gracePeriodInMin" : 60
        },
        "location" : {
            "id" : "locationId",
            "name" : "locationName"
        },
        "macAddressFormat" : 2,
        "walledGardens" : [ "10.11.12.16", "10.11.12.13" ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the Hotspot profile",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot profile"
            },
            "smartClientSupport" : {
                "description" : "SmartClientSupport of the Hotspot profile",
                "enum" : [ "None", "Enabled", "SmartClientOnly" ]
            },
            "smartClientInfo" : {
                "description" : "SmartClientInfo of the Hotspot profile",
                "type" : "string"
            },
            "portalType" : {
                "description" : "Portal type of the Hotspot profile",
                "enum" : [ "Internal", "External" ]
            },
            "portalUrl" : {
                "type" : "string",
                "description" : "Portal URL of the Hotspot profile"
            },
            "location" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Portal location id",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Portal location name",
                        "type" : "string"
                    }
                },
                "description" : "Location of the Hotspot profile"
            },
            "redirect" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "url" : {
                        "type" : "string",
                        "description" : "Portal redirect URL"
                    }
                },
                "description" : "Redirect configuration of the Hotspot profile"
            },
            "userSession" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "timeoutInMin" : {
                        "description" : "Time out value in minutes",
                        "type" : "integer",
                        "default" : 1440,
                        "minimum" : 2,
                        "maximum" : 14400
                    },
                    "gracePeriodInMin" : {
                        "description" : "Grace period in minutes",
                        "type" : "integer",
                        "default" : 60,
                        "minimum" : 1,
                        "maximum" : 14399
                    }
                },
                "description" : "User session of the Hotspot profile"
            },
            "walledGardens" : {
                "description" : "Walled garden map set of the Hotspot profile",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "macAddressFormat" : {
                "description" : "mac address format of redirection",
                "type" : "integer",
                "default" : 2,
                "minimum" : 0,
                "maximum" : 5
            }
        }
    }
    
    

Create Internal 

/v2_1/profiles/hotspot/internal

Use this API command to create a new Hotspot profile with internal logon URL.MacAddressFormat : 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)

  • Request
  • Body
    {
        "name" : "test-hotspot222",
        "description" : "description",
        "smartClientSupport" : "None",
        "portalUrl" : "https://172.17.26.59",
        "location" : {
            "id" : "locationId",
            "name" : "locationName"
        },
        "macAddressFormat" : 2,
        "walledGardens" : [ "10.11.12.16", "10.11.12.13" ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot"
            },
            "smartClientSupport" : {
                "description" : "Smart client support of the Hotspot",
                "enum" : [ "None", "Enabled" ]
            },
            "location" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Portal location id",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Portal location name",
                        "type" : "string"
                    }
                },
                "description" : "Location of the Hotspot"
            },
            "redirect" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "url" : {
                        "type" : "string",
                        "description" : "Portal redirect URL"
                    }
                },
                "description" : "Redirect configuration of the Hotspot"
            },
            "userSession" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "timeoutInMin" : {
                        "description" : "Time out value in minutes",
                        "type" : "integer",
                        "default" : 1440,
                        "minimum" : 2,
                        "maximum" : 14400
                    },
                    "gracePeriodInMin" : {
                        "description" : "Grace period in minutes",
                        "type" : "integer",
                        "default" : 60,
                        "minimum" : 1,
                        "maximum" : 14399
                    }
                },
                "description" : "User session of the Hotspot"
            },
            "walledGardens" : {
                "description" : "Walled garden map set of the Hotspot",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "macAddressFormat" : {
                "description" : "mac address format of redirection",
                "type" : "integer",
                "default" : 2,
                "minimum" : 0,
                "maximum" : 5
            }
        },
        "required" : [ "name", "smartClientSupport", "macAddressFormat" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the created portal profile",
                "type" : "string"
            }
        }
    }
    
    

Create External 

/v2_1/profiles/hotspot/external

Use this API command to create a new Hotspot profile with external logon URL.MacAddressFormat : 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)

  • Request
  • Body
    {
        "name" : "test-hotspot222",
        "description" : "description",
        "smartClientSupport" : "None",
        "portalUrl" : "https://172.17.26.59",
        "location" : {
            "id" : "locationId",
            "name" : "locationName"
        },
        "macAddressFormat" : 2,
        "walledGardens" : [ "10.11.12.16", "10.11.12.13" ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot"
            },
            "smartClientSupport" : {
                "description" : "Smart client support of the Hotspot",
                "enum" : [ "None", "Enabled" ]
            },
            "portalUrl" : {
                "type" : "string",
                "description" : "Portal URL of the Hotspot"
            },
            "location" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Portal location id",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Portal location name",
                        "type" : "string"
                    }
                },
                "description" : "Location of the hotspot"
            },
            "redirect" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "url" : {
                        "type" : "string",
                        "description" : "Portal redirect URL"
                    }
                },
                "description" : "Redirect configuration of the Hotspot"
            },
            "userSession" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "timeoutInMin" : {
                        "description" : "Time out value in minutes",
                        "type" : "integer",
                        "default" : 1440,
                        "minimum" : 2,
                        "maximum" : 14400
                    },
                    "gracePeriodInMin" : {
                        "description" : "Grace period in minutes",
                        "type" : "integer",
                        "default" : 60,
                        "minimum" : 1,
                        "maximum" : 14399
                    }
                },
                "description" : "User session of the Hotspot"
            },
            "walledGardens" : {
                "description" : "Walled garden map set of the Hotspot",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "macAddressFormat" : {
                "description" : "mac address format of redirection",
                "type" : "integer",
                "default" : 2,
                "minimum" : 0,
                "maximum" : 5
            }
        },
        "required" : [ "name", "smartClientSupport", "portalUrl", "macAddressFormat" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the created portal profile",
                "type" : "string"
            }
        }
    }
    
    

Create Smart Client Only 

/v2_1/profiles/hotspot/smartClientOnly

Use this API command to create a new Hotspot profile with smart client only.MacAddressFormat : 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)

  • Request
  • Body
    {
        "name" : "test-hotspot222-smartClientOnly",
        "description" : "description-smartClientOnly",
        "smartClientInfo" : "smartClient only, yyyy!",
        "location" : {
            "id" : "locationId",
            "name" : "locationName"
        },
        "macAddressFormat" : 2,
        "walledGardens" : [ "10.11.12.16", "10.11.12.13" ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot"
            },
            "smartClientInfo" : {
                "description" : "Smart client info of the Hotspot",
                "type" : "string"
            },
            "location" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Portal location id",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Portal location name",
                        "type" : "string"
                    }
                },
                "description" : "Location of the Hotspot"
            },
            "redirect" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "url" : {
                        "type" : "string",
                        "description" : "Portal redirect URL"
                    }
                },
                "description" : "Redirect configuration of the Hotspot"
            },
            "userSession" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "timeoutInMin" : {
                        "description" : "Time out value in minutes",
                        "type" : "integer",
                        "default" : 1440,
                        "minimum" : 2,
                        "maximum" : 14400
                    },
                    "gracePeriodInMin" : {
                        "description" : "Grace period in minutes",
                        "type" : "integer",
                        "default" : 60,
                        "minimum" : 1,
                        "maximum" : 14399
                    }
                },
                "description" : "Redirect configuration of the Hotspot profile"
            },
            "walledGardens" : {
                "description" : "Walled garden map set of the Hotspot",
                "type" : "array",
                "items" : {
                    "type" : "string"
                }
            },
            "macAddressFormat" : {
                "description" : "mac address format of redirection",
                "type" : "integer",
                "default" : 2,
                "minimum" : 0,
                "maximum" : 5
            }
        },
        "required" : [ "name", "smartClientInfo", "macAddressFormat" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the created portal profile",
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v2_1/profiles/hotspot/{id}

Use this API command to modify the basic information of a Hotspot profile.MacAddressFormat : 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)

  • Request
  • Body
    {
        "name" : "test-hotspot-modify",
        "description" : "description-modify",
        "smartClientSupport" : "Enabled",
        "smartClientInfo" : "info",
        "portalUrl" : "https://172.17.26.59",
        "macAddressFormat" : 2
    }
    
    
    Schema
    {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the Hotspot"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Hotspot"
        },
        "smartClientSupport" : {
            "description" : "Smart client support of the Hotspot",
            "enum" : [ "None", "Enabled" ]
        },
        "smartClientInfo" : {
            "description" : "Smart client info of the Hotspot",
            "type" : "string"
        },
        "portalUrl" : {
            "type" : "string",
            "description" : "Portal URL of the Hotspot"
        },
        "macAddressFormat" : {
            "description" : "mac address format of redirection",
            "type" : "integer",
            "default" : 2,
            "minimum" : 0,
            "maximum" : 5
        }
    }
    
    
  • Response  204

Modify Redirect 

/v2_1/profiles/hotspot/{id}/redirect

Use this API command to modify the redirect information of a Hotspot profile.

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

Modify Location 

/v2_1/profiles/hotspot/{id}/location

Use this API command to modify the location information of a Hotspot profile.

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

Modify Walled Gardens 

/v2_1/profiles/hotspot/{id}/walledGardens

Use this API command to modify a walled gardens of a Hotspot profile.

  • Request
  • Body
    [ "10.1.1.1", "11.11.111.11" ]
    
    
    Schema
    {
        "description" : "Walled garden map set of the Hotspot",
        "type" : "array",
        "items" : {
            "type" : "string"
        }
    }
    
    
  • Response  204

Delete 

/v2_1/profiles/hotspot/{id}

Use this API command to delete a Hotspot profile.

  • Response  204

Online Signup Profile 

Retrieve List 

/v2_1/profiles/osu

Use this API command to retrieve a list of online signup portal profiles.

  • 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" : [ {
            "id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
            "name" : "new name"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the profile",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the profile"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve 

/v2_1/profiles/osu/{id}

Use this API command to retrieve an online signup portal profile.

  • Response  200
  • Body
    {
        "id" : "b25a84f0-7f77-11e4-9abf-00606eb0c700",
        "name" : "public-api-osu-profile",
        "description" : "osu create desc",
        "portalCustomization" : {
            "language" : "zh_TW",
            "title" : "Welcome to the Guest Access login page.",
            "logo" : "logomsg",
            "termsAndConditionsText" : "test",
            "termsAndConditionsRequired" : true
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the online singup profile",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the online singup profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the online singup profile"
            },
            "portalCustomization" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "language" : {
                        "description" : "Language",
                        "default" : "en_US",
                        "enum" : [ "en_US", "zh_TW", "zh_CN", "nl_NL", "fr_FR", "de_DE", "ja_JP", "es_ES", "se_SE", "ar_SA", "cz_CZ", "da_DK", "tr_TR", "pt_BR" ]
                    },
                    "title" : {
                        "description" : "Title",
                        "type" : "string",
                        "minLength" : 0,
                        "maxLength" : 63
                    },
                    "logo" : {
                        "description" : "logo",
                        "type" : "string"
                    },
                    "termsAndConditionsRequired" : {
                        "description" : "Terms and conditions is required or not",
                        "type" : "boolean",
                        "default" : "false"
                    },
                    "termsAndConditionsText" : {
                        "description" : "Terms and conditions text",
                        "type" : "string",
                        "default" : "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
                        "minLength" : 0,
                        "maxLength" : 3999
                    }
                },
                "required" : [ "language" ],
                "description" : "Portal customization of the online singup profile"
            }
        }
    }
    
    

Create 

/v2_1/profiles/osu

Use this API command to create a new online signup portal profile.

  • Request
  • Body
    {
        "name" : "public-api-osu-profile",
        "description" : "osu create desc",
        "portalCustomization" : {
            "language" : "en_US",
            "title" : "abctitle",
            "logo" : "logomsg",
            "termsAndConditionsRequired" : true,
            "termsAndConditionsText" : "test"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the online singup profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the online singup profile"
            },
            "portalCustomization" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "language" : {
                        "description" : "Language",
                        "default" : "en_US",
                        "enum" : [ "en_US", "zh_TW", "zh_CN", "nl_NL", "fr_FR", "de_DE", "ja_JP", "es_ES", "se_SE", "ar_SA", "cz_CZ", "da_DK", "tr_TR", "pt_BR" ]
                    },
                    "title" : {
                        "description" : "Title",
                        "type" : "string",
                        "minLength" : 0,
                        "maxLength" : 63
                    },
                    "logo" : {
                        "description" : "logo",
                        "type" : "string"
                    },
                    "termsAndConditionsRequired" : {
                        "description" : "Terms and conditions is required or not",
                        "type" : "boolean",
                        "default" : "false"
                    },
                    "termsAndConditionsText" : {
                        "description" : "Terms and conditions text",
                        "type" : "string",
                        "default" : "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
                        "minLength" : 0,
                        "maxLength" : 3999
                    }
                },
                "required" : [ "language" ],
                "description" : "Portal customization of the online singup profile"
            }
        },
        "required" : [ "name", "portalCustomization" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "profileUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v2_1/profiles/osu/{id}

Use this API command to modify the basic information of an online signup portal profile.

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

Modify Portal Customization 

/v2_1/profiles/osu/{id}/portalCustomization

Use this API command to modify portal customization of an online signup portal profile.

  • Request
  • Body
    {
        "language" : "zh_TW",
        "title" : "Welcome to the Guest Access login page.",
        "logo" : "logomsg",
        "termsAndConditionsRequired" : true,
        "termsAndConditionsText" : "test"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "language" : {
                "description" : "Language",
                "default" : "en_US",
                "enum" : [ "en_US", "zh_TW", "zh_CN", "nl_NL", "fr_FR", "de_DE", "ja_JP", "es_ES", "se_SE", "ar_SA", "cz_CZ", "da_DK", "tr_TR", "pt_BR" ]
            },
            "title" : {
                "description" : "Title",
                "type" : "string",
                "minLength" : 0,
                "maxLength" : 63
            },
            "logo" : {
                "description" : "logo",
                "type" : "string"
            },
            "termsAndConditionsRequired" : {
                "description" : "Terms and conditions is required or not",
                "type" : "boolean",
                "default" : "false"
            },
            "termsAndConditionsText" : {
                "description" : "Terms and conditions text",
                "type" : "string",
                "default" : "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
                "minLength" : 0,
                "maxLength" : 3999
            }
        },
        "required" : [ "language" ],
        "description" : "Portal customization of the online singup profile"
    }
    
    
  • Response  204

Delete 

/v2_1/profiles/osu/{id}

Use this API command to delete an online signup portal profile.

  • Response  204

Hotspot20 Venue Profile 

Retrieve List 

/v2_1/rkszones/{zoneId}/hs20/venues

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

  • Response  200
  • Body
    {
        "totalCount" : 9,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "id" : "c5dfc930-75dc-11e4-8d56-00606eb0c700",
            "name" : "protalName1"
        }, {
            "id" : "15efd160-7153-11e4-aa08-00606eb0c700",
            "name" : "protalName2"
        }, {
            "id" : "be0f0480-73a9-11e4-9d1d-f0def13d5845",
            "name" : "protalName3"
        }, {
            "id" : "7f0eef00-7423-11e4-bcef-000c299b4765",
            "name" : "protalName4"
        }, {
            "id" : "4f5c98a0-7123-11e4-bcef-000c299b4765",
            "name" : "protalName5"
        }, {
            "id" : "4a023ce0-73ab-11e4-b211-f0def13d5845",
            "name" : "protalName6"
        }, {
            "id" : "afebbc80-73be-11e4-bfde-f0def13d5845",
            "name" : "protalName7"
        }, {
            "id" : "76f4c020-7620-11e4-b8b9-00606eb0c700",
            "name" : "protalName8"
        }, {
            "id" : "96308310-752c-11e4-8276-00606eb0c700",
            "name" : "protalName9"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the service",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the service"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve 

/v2_1/rkszones/{zoneId}/hs20/venues/{id}

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

  • Response  200
  • Body
    {
        "name" : "test-hs20Venue",
        "id" : "4136c9f0-7f6d-11e4-8fea-80fa5b024259",
        "description" : "des-hs20Venue",
        "zoneId" : "6b4279d6-a003-464e-9cbc-1e7ebee387c0",
        "group" : "UtilityAndMiscellaneous",
        "type" : "Unspecified",
        "downlinkSpeedInKbps" : 22,
        "uplinkSpeedInKbps" : 224,
        "venueNames" : [ {
            "language" : "English",
            "name" : "add friendly name"
        }, {
            "language" : "German",
            "name" : "add friendly name"
        }, {
            "language" : "Japanese",
            "name" : "add friendly name"
        }, {
            "language" : "Swedish",
            "name" : "add friendly name"
        }, {
            "language" : "Turkish",
            "name" : "add friendly name"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the Hotspot 2.0 venue profile",
                "type" : "string"
            },
            "zoneId" : {
                "description" : "Identifier of the zone which the Hotspot 2.0 venue profile belongs to",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot 2.0 venue profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot 2.0 venue profile"
            },
            "group" : {
                "description" : "Category group of the Hotspot 2.0 venue profile",
                "enum" : [ "Unspecified", "Assembly", "Business", "Educational", "FactoryAndIndustrial", "Institutional", "Mercantile", "Residential", "Storage", "UtilityAndMiscellaneous", "Vehicular", "Outdoor" ]
            },
            "type" : {
                "description" : "Category type of the Hotspot 2.0 venue profile",
                "type" : "string"
            },
            "downlinkSpeedInKbps" : {
                "description" : "Downlink Speed of the Hotspot 2.0 venue profile",
                "type" : "number",
                "minimum" : 0,
                "maximum" : 4294967295
            },
            "uplinkSpeedInKbps" : {
                "description" : "Uplink Speed of the Hotspot 2.0 venue profile",
                "type" : "number",
                "minimum" : 0,
                "maximum" : 4294967295
            },
            "venueNames" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "language" : {
                            "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
                            "description" : "Friendly name of venue"
                        },
                        "name" : {
                            "description" : "Venue name",
                            "type" : "string"
                        }
                    },
                    "required" : [ "language", "name" ]
                }
            }
        }
    }
    
    

Create 

/v2_1/rkszones/{zoneId}/hs20/venues

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

  • Request
  • Body
    {
        "name" : "test-hs20Venue",
        "description" : "des-hs20Venue",
        "group" : "UtilityAndMiscellaneous",
        "type" : "Unspecified",
        "downlinkSpeedInKbps" : 22,
        "uplinkSpeedInKbps" : 224,
        "venueNames" : [ {
            "language" : "English",
            "name" : "add friendly name"
        }, {
            "language" : "German",
            "name" : "add friendly name"
        }, {
            "language" : "Japanese",
            "name" : "add friendly name"
        }, {
            "language" : "Swedish",
            "name" : "add friendly name"
        }, {
            "language" : "Turkish",
            "name" : "add friendly name"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot 2.0 venue profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot 2.0 venue profile"
            },
            "group" : {
                "description" : "Category group of the Hotspot 2.0 venue profile",
                "enum" : [ "Unspecified", "Assembly", "Business", "Educational", "FactoryAndIndustrial", "Institutional", "Mercantile", "Residential", "Storage", "UtilityAndMiscellaneous", "Vehicular", "Outdoor" ]
            },
            "type" : {
                "description" : "Category type of the Hotspot 2.0 venue profile",
                "type" : "string"
            },
            "downlinkSpeedInKbps" : {
                "description" : "Downlink Speed of the Hotspot 2.0 venue profile",
                "type" : "number",
                "minimum" : 0,
                "maximum" : 4294967295
            },
            "uplinkSpeedInKbps" : {
                "description" : "Uplink Speed of the Hotspot 2.0 venue profile",
                "type" : "number",
                "minimum" : 0,
                "maximum" : 4294967295
            },
            "venueNames" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "language" : {
                            "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
                            "description" : "Friendly name of venue"
                        },
                        "name" : {
                            "description" : "Venue name",
                            "type" : "string"
                        }
                    },
                    "required" : [ "language", "name" ]
                }
            }
        },
        "required" : [ "name", "venueNames" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the created portal profile",
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v2_1/rkszones/{zoneId}/hs20/venues/{id}

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

  • Request
  • Body
    {
        "name" : "test-hs20Venue-modify",
        "description" : "des-hs20Venue-modify",
        "group" : "UtilityAndMiscellaneous",
        "type" : "Unspecified",
        "downlinkSpeedInKbps" : 111111,
        "uplinkSpeedInKbps" : 11111
    }
    
    
    Schema
    {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the Hotspot 2.0 venue profile"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Hotspot 2.0 venue profile"
        },
        "group" : {
            "description" : "Category group of the Hotspot 2.0 venue profile",
            "enum" : [ "Unspecified", "Assembly", "Business", "Educational", "FactoryAndIndustrial", "Institutional", "Mercantile", "Residential", "Storage", "UtilityAndMiscellaneous", "Vehicular", "Outdoor" ]
        },
        "type" : {
            "description" : "Category type of the Hotspot 2.0 venue profile",
            "type" : "string"
        },
        "downlinkSpeedInKbps" : {
            "description" : "Downlink Speed of the Hotspot 2.0 venue profile",
            "type" : "number",
            "minimum" : 0,
            "maximum" : 4294967295
        },
        "uplinkSpeedInKbps" : {
            "description" : "Uplink Speed of the Hotspot 2.0 venue profile",
            "type" : "number",
            "minimum" : 0,
            "maximum" : 4294967295
        }
    }
    
    
  • Response  204

Modify Venue Names 

/v2_1/rkszones/{zoneId}/hs20/venues/{id}/venueNames

Use this API command to modify the venue names on Hotspot 2.0 venue profile of a zone.

  • Request
  • Body
    [ {
        "language" : "English",
        "name" : "add friendly name"
    }, {
        "language" : "German",
        "name" : "add friendly name"
    }, {
        "language" : "Japanese",
        "name" : "add friendly name"
    }, {
        "language" : "Swedish",
        "name" : "add friendly name"
    }, {
        "language" : "Turkish",
        "name" : "add friendly name"
    } ]
    
    
    Schema
    {
        "type" : "array",
        "items" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "language" : {
                    "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
                    "description" : "Friendly name of venue"
                },
                "name" : {
                    "description" : "Venue name",
                    "type" : "string"
                }
            },
            "required" : [ "language", "name" ]
        }
    }
    
    
  • Response  204

Delete 

/v2_1/rkszones/{zoneId}/hs20/venues/{id}

Use this API command to delete Hotspot 2.0 venue profile of a zone.

  • Response  204

IPSEC Profile 

Retrieve List 

/v2_1/profiles/tunnel/ipsec

Retrieve a list of IPSEC

  • 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" : [ {
            "id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
            "name" : "new name"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the profile",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the profile"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve 

/v2_1/profiles/tunnel/ipsec/{id}

Retrieve a IPSEC

  • Response  200
  • Body
    {
        "id" : "0b767870-ab59-11e4-87f2-000c29c1611c",
        "name" : "ipsec content",
        "description" : "ipsec content description",
        "serverAddr" : "221.11.11.11",
        "authType" : "PresharedKey",
        "preSharedKey" : "2212222111",
        "ikeSecurityAssociation" : {
            "ikeProposalType" : "Specific",
            "ikeProposals" : [ {
                "encAlg" : "AES128",
                "authAlg" : "SHA1",
                "prfAlg" : "UseIntegrityALG",
                "dhGroup" : "Modp2048"
            }, {
                "encAlg" : "ThreeDES",
                "authAlg" : "MD5",
                "prfAlg" : "UseIntegrityALG",
                "dhGroup" : "Modp8192"
            } ]
        },
        "espSecurityAssociation" : {
            "espProposalType" : "Specific",
            "espProposals" : [ {
                "encAlg" : "AES128",
                "authAlg" : "SHA1",
                "dhGroup" : "Modp2048"
            }, {
                "encAlg" : "ThreeDES",
                "authAlg" : "MD5",
                "dhGroup" : "Modp8192"
            } ]
        },
        "ikeRekeyTime" : 0,
        "ikeRekeyTimeUnit" : "hour",
        "espRekeyTime" : 0,
        "espRekeyTimeUnit" : "day",
        "cmProtocolOption" : {
            "cmpDhcpOpt43Subcode" : 55,
            "cmpServerAddr" : "cmp test addr",
            "cmpServerPath" : "cmp test path",
            "cmpDhcpOpt43SubcodeRecipient" : 7,
            "cmpRecipient" : "CN=Jeff Smith,OU=Sales,DC=Fabrikam,DC=COM"
        },
        "advancedOption" : {
            "dhcpOpt43Subcode" : 8,
            "retryLimit" : 6,
            "replayWindow" : 30,
            "ipcompEnable" : "Enabled",
            "enforceNatt" : "Enabled",
            "dpdDelay" : 11,
            "keepAliveIntval" : 2,
            "failoverRetryPeriod" : 5,
            "failoverRetryInterval" : 6,
            "failoverMode" : "Revertive",
            "failoverPrimaryCheckInterval" : 7
        },
        "ipMode" : "IPV4"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "identifier of the ipsec profile",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "name of the ipsec profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "description of the ipsec profile"
            },
            "serverAddr" : {
                "description" : "server Addr of the ipsec profile",
                "type" : "string"
            },
            "authType" : {
                "description" : "authentication type of the ipsec profile",
                "enum" : [ "PresharedKey", "Certificate" ]
            },
            "preSharedKey" : {
                "description" : "authentication preShared Key of the ipsec profile",
                "type" : "string"
            },
            "ikeSecurityAssociation" : {
                "type" : "object",
                "description" : "ikeProposal Security Association of the ipsec profile ",
                "properties" : {
                    "ikeProposalType" : {
                        "description" : "ikeProposal Type of the ipsec profile",
                        "enum" : [ "Default", "Specific" ]
                    },
                    "ikeProposals" : {
                        "type" : "array",
                        "description" : "ikeProposal list of the ipsec profile ",
                        "items" : {
                            "type" : "object",
                            "description" : "IkeProposal based ipsec service mappings",
                            "properties" : {
                                "encAlg" : {
                                    "description" : "encAlg of ikeProposal Specific",
                                    "enum" : [ "ThreeDES", "AES128", "AES192", "AES256" ]
                                },
                                "authAlg" : {
                                    "description" : "authAlg of ikeProposal Specific",
                                    "enum" : [ "MD5", "SHA1", "AESXCBC", "SHA256", "SHA384", "SHA512" ]
                                },
                                "prfAlg" : {
                                    "description" : "prfAlg of ikeProposal Specific",
                                    "enum" : [ "UseIntegrityALG", "PRF_MD5", "PRF_SHA1", "PRF_AES_CBC", "PRF_AES_MAC", "PRF_SHA256", "PRF_SHA384", "PRF_SHA512" ]
                                },
                                "dhGroup" : {
                                    "description" : "dhGroup of ikeProposal Specific",
                                    "enum" : [ "Modp768", "Modp1024", "Modp1536", "Modp2048", "Modp3072", "Modp4096", "Modp6144", "Modp8192" ]
                                }
                            },
                            "required" : [ "encAlg", "authAlg", "prfAlg", "dhGroup" ]
                        }
                    }
                }
            },
            "espSecurityAssociation" : {
                "type" : "object",
                "description" : "espProposal Security Association of the ipsec profile ",
                "properties" : {
                    "espProposalType" : {
                        "description" : "espProposal Type of the ipsec profile",
                        "enum" : [ "Default", "Specific" ]
                    },
                    "espProposals" : {
                        "type" : "array",
                        "description" : "espProposal list of the ipsec profile ",
                        "items" : {
                            "type" : "object",
                            "description" : "EspProposal based ipsec service mappings",
                            "properties" : {
                                "encAlg" : {
                                    "description" : "encAlg of espProposal Specific",
                                    "enum" : [ "None", "ThreeDES", "AES128", "AES192", "AES256" ]
                                },
                                "authAlg" : {
                                    "description" : "authAlg of espProposal Specific",
                                    "enum" : [ "MD5", "SHA1", "AESXCBC", "SHA256", "SHA384", "SHA512" ]
                                },
                                "dhGroup" : {
                                    "description" : "dhGroup of espProposal Specific",
                                    "enum" : [ "None", "Modp768", "Modp1024", "Modp1536", "Modp2048", "Modp3072", "Modp4096", "Modp6144", "Modp8192" ]
                                }
                            },
                            "required" : [ "encAlg", "authAlg", "dhGroup" ]
                        }
                    }
                }
            },
            "ikeRekeyTime" : {
                "description" : "ikeRekey Time of the ipsec profile ",
                "type" : "number"
            },
            "ikeRekeyTimeUnit" : {
                "description" : "ikeRekey time unit of the ipsec profile ",
                "enum" : [ "second", "minute", "hour", "day" ]
            },
            "espRekeyTime" : {
                "description" : "espRekey Time of the ipsec profile ",
                "type" : "number"
            },
            "espRekeyTimeUnit" : {
                "description" : "espRekey time unit of the ipsec profile ",
                "enum" : [ "second", "minute", "hour", "day" ]
            },
            "cmProtocolOption" : {
                "type" : "object",
                "description" : "Certificate Management Protocol option of the ipsec profile ",
                "properties" : {
                    "cmpDhcpOpt43Subcode" : {
                        "description" : "Certificate Management Protocol dhcpOpt43Subcode",
                        "type" : "number"
                    },
                    "cmpServerAddr" : {
                        "description" : "Certificate Management Protocol Server addr",
                        "type" : "string"
                    },
                    "cmpServerPath" : {
                        "description" : "Certificate Management Protocol Server Path",
                        "type" : "string"
                    },
                    "cmpDhcpOpt43SubcodeRecipient" : {
                        "description" : "DhcpOpt43Subcode Recipient of Certificate Management Protocol",
                        "type" : "number",
                        "default" : 5,
                        "minimum" : 3,
                        "maximum" : 243
                    },
                    "cmpRecipient" : {
                        "description" : "Recipient of Certificate Management Protocol, ex.CN=Jeff Smith,OU=Sales,DC=Fabrikam,DC=COM ",
                        "type" : "string",
                        "minLength" : 0,
                        "maxLength" : 256
                    }
                },
                "required" : [ "cmpDhcpOpt43Subcode" ]
            },
            "advancedOption" : {
                "type" : "object",
                "description" : "advanced option of the ipsec profile ",
                "properties" : {
                    "dhcpOpt43Subcode" : {
                        "description" : "dhcpOpt43Subcode of the ipsec profile ",
                        "type" : "number"
                    },
                    "retryLimit" : {
                        "description" : "retryLimit of the ipsec profile ",
                        "type" : "number"
                    },
                    "replayWindow" : {
                        "description" : "replayWindow of the ipsec profile ",
                        "type" : "number"
                    },
                    "ipcompEnable" : {
                        "description" : "ipcomp Enable of the ipsec profile",
                        "enum" : [ "Disabled", "Enabled" ]
                    },
                    "enforceNatt" : {
                        "description" : "enforceNatt Enable of the ipsec profile",
                        "enum" : [ "Disabled", "Enabled" ]
                    },
                    "dpdDelay" : {
                        "description" : "dpdDelay of the ipsec profile ",
                        "type" : "number"
                    },
                    "keepAliveIntval" : {
                        "description" : "keepAliveIntval of the ipsec profile ",
                        "type" : "number"
                    },
                    "failoverRetryPeriod" : {
                        "description" : "Retry Period of the failover ",
                        "type" : "number"
                    },
                    "failoverRetryInterval" : {
                        "description" : " Retry Interval of the failover",
                        "type" : "number"
                    },
                    "failoverMode" : {
                        "description" : " mode of the failover",
                        "enum" : [ "Non_Revertive", "Revertive" ]
                    },
                    "failoverPrimaryCheckInterval" : {
                        "description" : " Primary Check Interval of the failover",
                        "type" : "number"
                    }
                }
            },
            "ipMode" : {
                "enum" : [ "IPV4", "IPV6" ],
                "description" : "ipMode of the ipsec profile "
            }
        }
    }
    
    

Create ipsec 

/v2_1/profiles/tunnel/ipsec

Create a new ipsec

  • Request
  • Body
    {
        "name" : "ipsec create",
        "description" : "ipsec create description",
        "serverAddr" : "111.11.11.11",
        "authType" : "PresharedKey",
        "preSharedKey" : "11111111111",
        "ikeRekeyTime" : 4,
        "espRekeyTime" : 1,
        "ikeRekeyTimeUnit" : "minute",
        "espRekeyTimeUnit" : "day",
        "ipMode" : "IPV4"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "name of the ipsec profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "description of the ipsec profile"
            },
            "serverAddr" : {
                "description" : "server Addr of the ipsec profile",
                "type" : "string"
            },
            "authType" : {
                "description" : "authentication type of the ipsec profile",
                "enum" : [ "PresharedKey", "Certificate" ]
            },
            "preSharedKey" : {
                "description" : "authentication preShared Key of the ipsec profile",
                "type" : "string"
            },
            "ikeRekeyTime" : {
                "description" : "ikeRekey Time of the ipsec profile ",
                "type" : "number"
            },
            "ikeRekeyTimeUnit" : {
                "description" : "ikeRekey time unit of the ipsec profile ",
                "enum" : [ "second", "minute", "hour", "day" ]
            },
            "espRekeyTime" : {
                "description" : "espRekey Time of the ipsec profile ",
                "type" : "number"
            },
            "espRekeyTimeUnit" : {
                "description" : "espRekey time unit of the ipsec profile ",
                "enum" : [ "second", "minute", "hour", "day" ]
            },
            "ipMode" : {
                "enum" : [ "IPV4", "IPV6" ],
                "description" : "ipMode of the ipsec profile "
            }
        },
        "required" : [ "name", "ikeRekeyTime", "espRekeyTime", "ipMode" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "profileUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v2_1/profiles/tunnel/ipsec/{id}

Modify a specific ipsec basic

  • Request
  • Body
    {
        "name" : "ipsec moify",
        "description" : "ipsec modify description",
        "serverAddr" : "221.11.11.11",
        "authType" : "PresharedKey",
        "preSharedKey" : "2212222111",
        "ikeRekeyTime" : 5,
        "ikeRekeyTimeUnit" : "hour",
        "espRekeyTime" : 6,
        "espRekeyTimeUnit" : "day"
    }
    
    
    Schema
    {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "name of the ipsec profile"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "description of the ipsec profile"
        },
        "serverAddr" : {
            "description" : "server Addr of the ipsec profile",
            "type" : "string"
        },
        "authType" : {
            "description" : "authentication type of the ipsec profile",
            "enum" : [ "PresharedKey", "Certificate" ]
        },
        "preSharedKey" : {
            "description" : "authentication preShared Key of the ipsec profile",
            "type" : "string"
        },
        "ikeRekeyTime" : {
            "description" : "ikeRekey Time of the ipsec profile ",
            "type" : "number"
        },
        "ikeRekeyTimeUnit" : {
            "description" : "ikeRekey time unit of the ipsec profile ",
            "enum" : [ "second", "minute", "hour", "day" ]
        },
        "espRekeyTime" : {
            "description" : "espRekey Time of the ipsec profile ",
            "type" : "number"
        },
        "espRekeyTimeUnit" : {
            "description" : "espRekey time unit of the ipsec profile ",
            "enum" : [ "second", "minute", "hour", "day" ]
        }
    }
    
    
  • Response  204

Modify ikeSecurityAssociation 

/v2_1/profiles/tunnel/ipsec/{id}/ikeSecurityAssociation

Modify a specific ipsec ikeSecurityAssociation

  • Request
  • Body
    {
        "ikeProposalType" : "Specific",
        "ikeProposals" : [ {
            "encAlg" : "AES128",
            "authAlg" : "SHA1",
            "prfAlg" : "UseIntegrityALG",
            "dhGroup" : "Modp2048"
        }, {
            "encAlg" : "ThreeDES",
            "authAlg" : "MD5",
            "prfAlg" : "UseIntegrityALG",
            "dhGroup" : "Modp8192"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "description" : "ikeProposal Security Association of the ipsec profile ",
        "properties" : {
            "ikeProposalType" : {
                "description" : "ikeProposal Type of the ipsec profile",
                "enum" : [ "Default", "Specific" ]
            },
            "ikeProposals" : {
                "type" : "array",
                "description" : "ikeProposal list of the ipsec profile ",
                "items" : {
                    "type" : "object",
                    "description" : "IkeProposal based ipsec service mappings",
                    "properties" : {
                        "encAlg" : {
                            "description" : "encAlg of ikeProposal Specific",
                            "enum" : [ "ThreeDES", "AES128", "AES192", "AES256" ]
                        },
                        "authAlg" : {
                            "description" : "authAlg of ikeProposal Specific",
                            "enum" : [ "MD5", "SHA1", "AESXCBC", "SHA256", "SHA384", "SHA512" ]
                        },
                        "prfAlg" : {
                            "description" : "prfAlg of ikeProposal Specific",
                            "enum" : [ "UseIntegrityALG", "PRF_MD5", "PRF_SHA1", "PRF_AES_CBC", "PRF_AES_MAC", "PRF_SHA256", "PRF_SHA384", "PRF_SHA512" ]
                        },
                        "dhGroup" : {
                            "description" : "dhGroup of ikeProposal Specific",
                            "enum" : [ "Modp768", "Modp1024", "Modp1536", "Modp2048", "Modp3072", "Modp4096", "Modp6144", "Modp8192" ]
                        }
                    },
                    "required" : [ "encAlg", "authAlg", "prfAlg", "dhGroup" ]
                }
            }
        }
    }
    
    
  • Response  204

Modify espSecurityAssociation 

/v2_1/profiles/tunnel/ipsec/{id}/espSecurityAssociation

Modify a specific ipsec espSecurityAssociation

  • Request
  • Body
    {
        "espProposalType" : "Specific",
        "espProposals" : [ {
            "encAlg" : "AES128",
            "authAlg" : "SHA1",
            "dhGroup" : "Modp2048"
        }, {
            "encAlg" : "ThreeDES",
            "authAlg" : "MD5",
            "dhGroup" : "Modp8192"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "description" : "espProposal Security Association of the ipsec profile ",
        "properties" : {
            "espProposalType" : {
                "description" : "espProposal Type of the ipsec profile",
                "enum" : [ "Default", "Specific" ]
            },
            "espProposals" : {
                "type" : "array",
                "description" : "espProposal list of the ipsec profile ",
                "items" : {
                    "type" : "object",
                    "description" : "EspProposal based ipsec service mappings",
                    "properties" : {
                        "encAlg" : {
                            "description" : "encAlg of espProposal Specific",
                            "enum" : [ "None", "ThreeDES", "AES128", "AES192", "AES256" ]
                        },
                        "authAlg" : {
                            "description" : "authAlg of espProposal Specific",
                            "enum" : [ "MD5", "SHA1", "AESXCBC", "SHA256", "SHA384", "SHA512" ]
                        },
                        "dhGroup" : {
                            "description" : "dhGroup of espProposal Specific",
                            "enum" : [ "None", "Modp768", "Modp1024", "Modp1536", "Modp2048", "Modp3072", "Modp4096", "Modp6144", "Modp8192" ]
                        }
                    },
                    "required" : [ "encAlg", "authAlg", "dhGroup" ]
                }
            }
        }
    }
    
    
  • Response  204

Modify cmProtocolOption 

/v2_1/profiles/tunnel/ipsec/{id}/cmProtocolOption

Modify a specific ipsec cmProtocolOption

  • Request
  • Body
    {
        "cmpDhcpOpt43Subcode" : 55,
        "cmpServerAddr" : "cmp test addr",
        "cmpServerPath" : "cmp test path",
        "cmpDhcpOpt43SubcodeRecipient" : 7,
        "cmpRecipient" : "CN=Jeff Smith,OU=Sales,DC=Fabrikam,DC=COM"
    }
    
    
    Schema
    {
        "type" : "object",
        "description" : "Certificate Management Protocol option of the ipsec profile ",
        "properties" : {
            "cmpDhcpOpt43Subcode" : {
                "description" : "Certificate Management Protocol dhcpOpt43Subcode",
                "type" : "number"
            },
            "cmpServerAddr" : {
                "description" : "Certificate Management Protocol Server addr",
                "type" : "string"
            },
            "cmpServerPath" : {
                "description" : "Certificate Management Protocol Server Path",
                "type" : "string"
            },
            "cmpDhcpOpt43SubcodeRecipient" : {
                "description" : "DhcpOpt43Subcode Recipient of Certificate Management Protocol",
                "type" : "number",
                "default" : 5,
                "minimum" : 3,
                "maximum" : 243
            },
            "cmpRecipient" : {
                "description" : "Recipient of Certificate Management Protocol, ex.CN=Jeff Smith,OU=Sales,DC=Fabrikam,DC=COM ",
                "type" : "string",
                "minLength" : 0,
                "maxLength" : 256
            }
        },
        "required" : [ "cmpDhcpOpt43Subcode" ]
    }
    
    
  • Response  204

Modify advancedOption 

/v2_1/profiles/tunnel/ipsec/{id}/advancedOption

Modify a specific ipsec advancedOption

  • Request
  • Body
    {
        "dhcpOpt43Subcode" : 8,
        "retryLimit" : 6,
        "replayWindow" : 30,
        "ipcompEnable" : "Enabled",
        "enforceNatt" : "Enabled",
        "dpdDelay" : 11,
        "keepAliveIntval" : 2,
        "failoverRetryPeriod" : 5,
        "failoverRetryInterval" : 6,
        "failoverMode" : "Revertive",
        "failoverPrimaryCheckInterval" : 7
    }
    
    
    Schema
    {
        "type" : "object",
        "description" : "advanced option of the ipsec profile ",
        "properties" : {
            "dhcpOpt43Subcode" : {
                "description" : "dhcpOpt43Subcode of the ipsec profile ",
                "type" : "number"
            },
            "retryLimit" : {
                "description" : "retryLimit of the ipsec profile ",
                "type" : "number"
            },
            "replayWindow" : {
                "description" : "replayWindow of the ipsec profile ",
                "type" : "number"
            },
            "ipcompEnable" : {
                "description" : "ipcomp Enable of the ipsec profile",
                "enum" : [ "Disabled", "Enabled" ]
            },
            "enforceNatt" : {
                "description" : "enforceNatt Enable of the ipsec profile",
                "enum" : [ "Disabled", "Enabled" ]
            },
            "dpdDelay" : {
                "description" : "dpdDelay of the ipsec profile ",
                "type" : "number"
            },
            "keepAliveIntval" : {
                "description" : "keepAliveIntval of the ipsec profile ",
                "type" : "number"
            },
            "failoverRetryPeriod" : {
                "description" : "Retry Period of the failover ",
                "type" : "number"
            },
            "failoverRetryInterval" : {
                "description" : " Retry Interval of the failover",
                "type" : "number"
            },
            "failoverMode" : {
                "description" : " mode of the failover",
                "enum" : [ "Non_Revertive", "Revertive" ]
            },
            "failoverPrimaryCheckInterval" : {
                "description" : " Primary Check Interval of the failover",
                "type" : "number"
            }
        }
    }
    
    
  • Response  204

Delete 

/v2_1/profiles/tunnel/ipsec/{id}

Delete a ipsec

  • Response  204

Hotspot20 Wi-Fi Operator Profile 

Retrieve List 

/v2_1/profiles/hs20/operators

Use this API command to retrieve list of Hotspot 2.0 Wi-Fi Operators.

  • 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" : [ {
            "id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
            "name" : "new name"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the profile",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the profile"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve 

/v2_1/profiles/hs20/operators/{id}

Use this API command to retrieve a Hotspot 2.0 Wi-Fi operator.

  • Response  200
  • Body
    {
        "name" : "public-api-operator",
        "description" : "description-changed",
        "domainNames" : [ "ruckus.com" ],
        "friendlyNames" : [ {
            "language" : "English",
            "name" : "ruckus"
        } ],
        "certificate" : {
            "id" : "certificateID",
            "name" : "certificateName"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the profile",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot 2.0 Wifi operator profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot 2.0 Wifi operator profile"
            },
            "domainNames" : {
                "description" : "Domain names",
                "type" : "array",
                "items" : {
                    "description" : "Compare with FQDN, it could start with '*.'",
                    "type" : "string",
                    "pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
                }
            },
            "friendlyNames" : {
                "description" : "Friendly names",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "language" : {
                            "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
                            "description" : "Language of the friendly name"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the friendly name"
                        }
                    },
                    "required" : [ "language", "name" ]
                }
            },
            "certificate" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Signup security certificate"
            }
        },
        "required" : [ "name", "domainNames", "friendlyNames" ]
    }
    
    

Create 

/v2_1/profiles/hs20/operators

Use this API command to create a new Hotspot 2.0 Wi-Fi operator,

  • Request
  • Body
    {
        "name" : "public-api-operator",
        "domainNames" : [ "ruckus.com" ],
        "friendlyNames" : [ {
            "language" : "English",
            "name" : "ruckus"
        } ],
        "certificate" : {
            "id" : "certificateID",
            "name" : "certificateName"
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot 2.0 Wifi operator profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot2.0 Wifi operator profile"
            },
            "domainNames" : {
                "description" : "Domain names",
                "type" : "array",
                "items" : {
                    "description" : "Compare with FQDN, it could start with '*.'",
                    "type" : "string",
                    "pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
                }
            },
            "friendlyNames" : {
                "description" : "Friendly names",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "language" : {
                            "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
                            "description" : "Language of the friendly name"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the friendly name"
                        }
                    },
                    "required" : [ "language", "name" ]
                }
            },
            "certificate" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Signup security certificate"
            }
        },
        "required" : [ "name", "domainNames", "friendlyNames" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "profileUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v2_1/profiles/hs20/operators/{id}

Use this API command to modify the basic information of a Hotspot 2.0 Wi-Fi operator.

  • Request
  • Body
    {
        "name" : "public-api-operator-changed",
        "description" : "description-changed"
    }
    
    
    Schema
    {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the Hotspot 2.0 Wifi operator profile"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Hotspot 2.0 Wifi operator profile"
        }
    }
    
    
  • Response  204

Modify Domain Names 

/v2_1/profiles/hs20/operators/{id}/domainNames

Use this API command to modify domain names of a Hotspot 2.0 Wi-Fi operator.

  • Request
  • Body
    [ "ruckus.com" ]
    
    
    Schema
    {
        "description" : "Domain names",
        "type" : "array",
        "items" : {
            "description" : "Compare with FQDN, it could start with '*.'",
            "type" : "string",
            "pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
        }
    }
    
    
  • Response  204

Modify Friendly Names 

/v2_1/profiles/hs20/operators/{id}/friendlyNames

Use this API command to modify friendly names of a Hotspot 2.0 Wi-Fi operator.

  • Request
  • Body
    [ {
        "language" : "English",
        "name" : "ruckus"
    } ]
    
    
    Schema
    {
        "description" : "Friendly names",
        "type" : "array",
        "items" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "language" : {
                    "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
                    "description" : "Language of the friendly name"
                },
                "name" : {
                    "type" : "string",
                    "minLength" : 2,
                    "maxLength" : 32,
                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                    "description" : "Name of the friendly name"
                }
            },
            "required" : [ "language", "name" ]
        }
    }
    
    
  • Response  204

Modify Certificate 

/v2_1/profiles/hs20/operators/{id}/certificate

Use this API command to enable or modify certificate of a Hotspot 2.0 Wi-Fi operator.

  • Request
  • Body
    {
        "id" : "certificateID",
        "name" : "certificateName"
    }
    
    
    Schema
    {
        "type" : [ "object", "null" ],
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            },
            "name" : {
                "type" : "string"
            }
        },
        "description" : "Signup security certificate"
    }
    
    
  • Response  204

Disable Certificate 

/v2_1/profiles/hs20/operators/{id}/certificate

Use this API command to disable certificate of a Hotspot 2.0 Wi-Fi operator.

  • Response  204

Delete 

/v2_1/profiles/hs20/operators/{id}

Use this API command to delete a Hotspot 2.0 Wi-Fi operator.

  • Response  204

Hotspot20 Identity Provider Profile 

Retrieve List 

/v2_1/profiles/hs20/identityproviders

Use this API command to retrieve list of Hotspot 2.0 identity providers.

  • 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" : [ {
            "id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
            "name" : "new name"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the profile",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the profile"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve 

/v2_1/profiles/hs20/identityproviders/{id}

Use this API command to retrieve a Hotspot 2.0 identity provider.

  • Response  200
  • Body
    {
        "id" : "1fb20eaf-7b9b-40c7-8b9b-7d69d6165176",
        "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
        "name" : "hs20IdentithInternalOSU",
        "description" : "",
        "realms" : [ {
            "name" : "reamlll",
            "encoding" : "RFC4282",
            "eapMethods" : [ {
                "type" : "NA",
                "authSettings" : null
            }, {
                "type" : "NA",
                "authSettings" : null
            }, {
                "type" : "NA",
                "authSettings" : null
            }, {
                "type" : "NA",
                "authSettings" : null
            } ]
        } ],
        "plmns" : null,
        "homeOis" : null,
        "authentications" : [ {
            "id" : "868b0b20-8598-11e4-8acc-08002716c79f",
            "name" : "globalRadius",
            "realm" : "globalAuth",
            "serviceType" : "RADIUS",
            "vlanId" : 23,
            "refBlank" : false
        }, {
            "id" : null,
            "name" : null,
            "realm" : "No Match",
            "serviceType" : "NA",
            "vlanId" : null,
            "refBlank" : true
        }, {
            "id" : null,
            "name" : null,
            "realm" : "Unspecified",
            "serviceType" : "NA",
            "vlanId" : null,
            "refBlank" : true
        } ],
        "accountings" : [ {
            "id" : "789ff6b0-8598-11e4-8acc-08002716c79f",
            "name" : "globalRadiusAcct",
            "realm" : "globalAcct",
            "serviceType" : "RADIUS",
            "refBlank" : false
        }, {
            "id" : null,
            "name" : null,
            "realm" : "No Match",
            "serviceType" : "NA",
            "refBlank" : true
        }, {
            "id" : null,
            "name" : null,
            "realm" : "Unspecified",
            "serviceType" : "NA",
            "refBlank" : true
        } ],
        "osu" : {
            "type" : "Internal",
            "internalOSU" : {
                "provisioningProtocals" : [ "SOAP_XML" ],
                "provisioningFormat" : "R1_R2_ZEROIT",
                "provisioningUpdateType" : "NEVER",
                "osuPortal" : {
                    "type" : "Internal",
                    "internalOSUPortal" : {
                        "id" : "24cdfc80-8598-11e4-8acc-08002716c79f",
                        "name" : null,
                        "refBlank" : false
                    },
                    "externalUrl" : null
                },
                "commonLanguageIcon" : "imageDATA",
                "serviceDescriptions" : [ {
                    "language" : "English",
                    "name" : "ruckus",
                    "description" : "",
                    "icon" : ""
                } ],
                "certificate" : {
                    "id" : "certificateID",
                    "name" : "certificateName"
                },
                "osuAuthServices" : [ {
                    "id" : "11111111-1111-1111-1111-111111111111",
                    "name" : null,
                    "credentialType" : "LOCAL",
                    "realm" : "reamlll",
                    "expiration" : -1,
                    "refBlank" : false
                } ],
                "whitelistedDomains" : [ ]
            },
            "externalOSU" : null
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the Hotspot 2.0 identity provider profile",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot 2.0 identity provider profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot 2.0 identity provider profile"
            },
            "realms" : {
                "description" : "Realms",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of realm"
                        },
                        "encoding" : {
                            "description" : "Encoding",
                            "enum" : [ "RFC4282", "UTF8" ]
                        },
                        "eapMethods" : {
                            "description" : "EAP methods",
                            "type" : "array",
                            "items" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "properties" : {
                                    "type" : {
                                        "description" : "EAP method type",
                                        "enum" : [ "NA", "MD5", "EAP_TLS", "EAP_Cisco", "EAP_SIM", "EAP_TTLS", "EAP_AKA", "PEAP", "EAP_MSCHAP_V2", "EAP_AKAs", "Reserved" ]
                                    },
                                    "authSettings" : {
                                        "description" : "EAP method auth settings",
                                        "type" : [ "array", "null" ],
                                        "items" : {
                                            "type" : "object",
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "info" : {
                                                    "description" : "EAP auth info",
                                                    "enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
                                                },
                                                "type" : {
                                                    "description" : "EAP auth type",
                                                    "type" : "string"
                                                },
                                                "vendorId" : {
                                                    "description" : "EAP auth vendor ID",
                                                    "type" : [ "integer", "null" ],
                                                    "minimum" : 0,
                                                    "maximum" : 16777215
                                                },
                                                "vendorType" : {
                                                    "description" : "EAP auth vendor type",
                                                    "type" : [ "integer", "null" ],
                                                    "minimum" : 0,
                                                    "maximum" : 4294967295
                                                }
                                            },
                                            "required" : [ "info" ]
                                        }
                                    }
                                },
                                "required" : [ "type" ]
                            }
                        }
                    },
                    "required" : [ "name", "encoding", "eapMethods" ]
                }
            },
            "plmns" : {
                "description" : "PLMNs",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "mcc" : {
                            "description" : "MCC",
                            "type" : "string",
                            "pattern" : "^[0-9]{3}$"
                        },
                        "mnc" : {
                            "description" : "MNC",
                            "type" : "string",
                            "pattern" : "^[0-9]{2,3}$"
                        }
                    },
                    "required" : [ "mcc", "mnc" ]
                }
            },
            "homeOis" : {
                "description" : "Home OIs",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "name" : {
                            "description" : "Name of the home OI",
                            "type" : "string",
                            "maxLength" : 255
                        },
                        "oi" : {
                            "description" : "Orgnization ID(3Hex or 5Hex)",
                            "type" : "string",
                            "pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
                        }
                    },
                    "required" : [ "name", "oi" ]
                }
            },
            "authentications" : {
                "description" : "Authentications",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Authentication id",
                            "type" : [ "string", "null" ]
                        },
                        "name" : {
                            "description" : "Authentication name",
                            "type" : [ "string", "null" ]
                        },
                        "realm" : {
                            "type" : "string",
                            "maxLength" : 255,
                            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                            "description" : "Authentication realm"
                        },
                        "serviceType" : {
                            "description" : "Authentication service type",
                            "enum" : [ "NA", "LOCAL_DB", "RADIUS" ]
                        },
                        "vlanId" : {
                            "description" : "Dynamic vlan ID",
                            "type" : [ "integer", "null" ],
                            "minimum" : 1,
                            "maximum" : 4094
                        }
                    },
                    "required" : [ "realm", "serviceType" ]
                }
            },
            "accountings" : {
                "description" : "Accountings",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Accounting id",
                            "type" : [ "string", "null" ]
                        },
                        "name" : {
                            "description" : "Accounting name",
                            "type" : [ "string", "null" ]
                        },
                        "realm" : {
                            "type" : "string",
                            "maxLength" : 255,
                            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
                        },
                        "serviceType" : {
                            "description" : "Accounting service type",
                            "enum" : [ "NA", "RADIUS", "CGF" ]
                        }
                    },
                    "required" : [ "realm", "serviceType" ]
                }
            },
            "osu" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "type" : {
                        "description" : "Online singup type",
                        "enum" : [ "Internal", "External" ]
                    },
                    "internalOSU" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "provisioningProtocals" : {
                                "description" : "Provisioning protocal",
                                "type" : "array",
                                "items" : {
                                    "enum" : [ "SOAP_XML", "OMA_DM" ]
                                }
                            },
                            "provisioningFormat" : {
                                "description" : "Provisioning format",
                                "enum" : [ "R1_R2_ZEROIT", "R2_ZEROIT" ]
                            },
                            "provisioningUpdateType" : {
                                "description" : "Provisioning update at",
                                "enum" : [ "ALWAYS", "KNOWN_ROAM_PARTNERS", "NEVER" ]
                            },
                            "osuPortal" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "properties" : {
                                    "type" : {
                                        "description" : "Portal type",
                                        "enum" : [ "Internal", "External" ]
                                    },
                                    "internalOSUPortal" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        },
                                        "description" : "Internal online singup portal, required when type is Internal"
                                    },
                                    "externalUrl" : {
                                        "type" : [ "string", "null" ],
                                        "pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$",
                                        "description" : "External online singup portal, start with https://, required when type is External"
                                    }
                                },
                                "required" : [ "type" ]
                            },
                            "commonLanguageIcon" : {
                                "description" : "The base64 encoded data of icon.",
                                "type" : "string"
                            },
                            "subscriptionDescriptions" : {
                                "description" : "Subscription descriptions",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "language" : {
                                            "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
                                            "description" : "Language of the friendly name"
                                        },
                                        "name" : {
                                            "type" : "string",
                                            "minLength" : 2,
                                            "maxLength" : 32,
                                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                            "description" : "Name of the friendly name"
                                        },
                                        "description" : {
                                            "type" : [ "string", "null" ],
                                            "maxLength" : 64,
                                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                                            "description" : "Description of the friendly name"
                                        },
                                        "icon" : {
                                            "description" : "The binary data of icon, maximum size 65536",
                                            "type" : "string"
                                        }
                                    },
                                    "required" : [ "language", "name" ]
                                }
                            },
                            "certificate" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "id" : {
                                        "type" : "string"
                                    },
                                    "name" : {
                                        "type" : "string"
                                    }
                                },
                                "description" : "Online signup certificate"
                            },
                            "osuAuthServices" : {
                                "description" : "Online signup authentication services",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "id" : {
                                            "description" : "Identifier of authentication service",
                                            "type" : "string"
                                        },
                                        "name" : {
                                            "description" : "Authentication service name",
                                            "type" : "string"
                                        },
                                        "credentialType" : {
                                            "description" : "Authentication credential type",
                                            "enum" : [ "LOCAL", "REMOTE" ]
                                        },
                                        "realm" : {
                                            "type" : "string",
                                            "maxLength" : 255,
                                            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                            "description" : "Authentication realm"
                                        },
                                        "expiration" : {
                                            "description" : "Expiration hour. null mean never expire",
                                            "type" : [ "integer", "null" ],
                                            "minimum" : 1,
                                            "maximum" : 175200
                                        }
                                    },
                                    "required" : [ "credentialType", "realm" ]
                                }
                            },
                            "whitelistedDomains" : {
                                "description" : "whitelisted domains",
                                "type" : "array",
                                "items" : {
                                    "description" : "Compare with FQDN, it could start with '*.'",
                                    "type" : "string",
                                    "pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
                                }
                            }
                        },
                        "required" : [ "provisioningProtocals", "provisioningFormat", "provisioningUpdateType", "osuPortal", "commonLanguageIcon", "subscriptionDescriptions", "certificate", "osuAuthServices" ],
                        "description" : "Internal online singup, required when type is Internal"
                    },
                    "externalOSU" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "provisioningProtocals" : {
                                "description" : "Provisioning protocal",
                                "type" : "array",
                                "item" : {
                                    "enum" : [ "SOAP_XML", "OMA_DM" ]
                                }
                            },
                            "osuServiceUrl" : {
                                "type" : [ "string", "null" ],
                                "pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$",
                                "description" : "External service URL, start with https://"
                            },
                            "osuNaiRealm" : {
                                "description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
                                "type" : "string"
                            },
                            "commonLanguageIcon" : {
                                "description" : "The base64 encoded data of icon.",
                                "type" : "string"
                            },
                            "subscriptionDescriptions" : {
                                "description" : "Subscription descriptions",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "language" : {
                                            "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
                                            "description" : "Language of the friendly name"
                                        },
                                        "name" : {
                                            "type" : "string",
                                            "minLength" : 2,
                                            "maxLength" : 32,
                                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                            "description" : "Name of the friendly name"
                                        },
                                        "description" : {
                                            "type" : [ "string", "null" ],
                                            "maxLength" : 64,
                                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                                            "description" : "Description of the friendly name"
                                        },
                                        "icon" : {
                                            "description" : "The binary data of icon, maximum size 65536",
                                            "type" : "string"
                                        }
                                    },
                                    "required" : [ "language", "name" ]
                                }
                            },
                            "whitelistedDomains" : {
                                "description" : "Whitelisted domains",
                                "type" : "array",
                                "items" : {
                                    "description" : "Compare with FQDN, it could start with '*.'",
                                    "type" : "string",
                                    "pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
                                }
                            }
                        },
                        "required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ],
                        "description" : "External online singup, required when type is External"
                    }
                },
                "required" : [ "type" ],
                "description" : "Online Signup & Provisioning"
            }
        }
    }
    
    

Create 

/v2_1/profiles/hs20/identityproviders

Use this API command to create a new Hotspot 2.0 identity provider.

  • Request
  • Body
    {
        "name" : "test-hs20provider",
        "realms" : [ {
            "name" : "realm1",
            "encoding" : "RFC4282",
            "eapMethods" : [ {
                "type" : "NA"
            }, {
                "type" : "NA"
            }, {
                "type" : "NA"
            }, {
                "type" : "NA"
            } ]
        } ],
        "authentications" : [ {
            "realm" : "No Match",
            "serviceType" : "NA"
        }, {
            "realm" : "Unspecified",
            "serviceType" : "NA"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the Hotspot 2.0 identity provider profile"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the Hotspot 2.0 identity provider profile"
            },
            "realms" : {
                "description" : "Realms",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of realm"
                        },
                        "encoding" : {
                            "description" : "Encoding",
                            "enum" : [ "RFC4282", "UTF8" ]
                        },
                        "eapMethods" : {
                            "description" : "EAP methods",
                            "type" : "array",
                            "items" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "properties" : {
                                    "type" : {
                                        "description" : "EAP method type",
                                        "enum" : [ "NA", "MD5", "EAP_TLS", "EAP_Cisco", "EAP_SIM", "EAP_TTLS", "EAP_AKA", "PEAP", "EAP_MSCHAP_V2", "EAP_AKAs", "Reserved" ]
                                    },
                                    "authSettings" : {
                                        "description" : "EAP method auth settings",
                                        "type" : [ "array", "null" ],
                                        "items" : {
                                            "type" : "object",
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "info" : {
                                                    "description" : "EAP auth info",
                                                    "enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
                                                },
                                                "type" : {
                                                    "description" : "EAP auth type",
                                                    "type" : "string"
                                                },
                                                "vendorId" : {
                                                    "description" : "EAP auth vendor ID",
                                                    "type" : [ "integer", "null" ],
                                                    "minimum" : 0,
                                                    "maximum" : 16777215
                                                },
                                                "vendorType" : {
                                                    "description" : "EAP auth vendor type",
                                                    "type" : [ "integer", "null" ],
                                                    "minimum" : 0,
                                                    "maximum" : 4294967295
                                                }
                                            },
                                            "required" : [ "info" ]
                                        }
                                    }
                                },
                                "required" : [ "type" ]
                            }
                        }
                    },
                    "required" : [ "name", "encoding", "eapMethods" ]
                }
            },
            "plmns" : {
                "description" : "PLMNs",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "mcc" : {
                            "description" : "MCC",
                            "type" : "string",
                            "pattern" : "^[0-9]{3}$"
                        },
                        "mnc" : {
                            "description" : "MNC",
                            "type" : "string",
                            "pattern" : "^[0-9]{2,3}$"
                        }
                    },
                    "required" : [ "mcc", "mnc" ]
                }
            },
            "homeOis" : {
                "description" : "Home OIs",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "name" : {
                            "description" : "Name of the home OI",
                            "type" : "string",
                            "maxLength" : 255
                        },
                        "oi" : {
                            "description" : "Orgnization ID(3Hex or 5Hex)",
                            "type" : "string",
                            "pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
                        }
                    },
                    "required" : [ "name", "oi" ]
                }
            },
            "authentications" : {
                "description" : "Authentications",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Authentication id",
                            "type" : [ "string", "null" ]
                        },
                        "name" : {
                            "description" : "Authentication name",
                            "type" : [ "string", "null" ]
                        },
                        "realm" : {
                            "type" : "string",
                            "maxLength" : 255,
                            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                            "description" : "Authentication realm"
                        },
                        "serviceType" : {
                            "description" : "Authentication service type",
                            "enum" : [ "NA", "LOCAL_DB", "RADIUS" ]
                        },
                        "vlanId" : {
                            "description" : "Dynamic vlan ID",
                            "type" : [ "integer", "null" ],
                            "minimum" : 1,
                            "maximum" : 4094
                        }
                    },
                    "required" : [ "realm", "serviceType" ]
                }
            },
            "accountings" : {
                "description" : "Accountings",
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Accounting id",
                            "type" : [ "string", "null" ]
                        },
                        "name" : {
                            "description" : "Accounting name",
                            "type" : [ "string", "null" ]
                        },
                        "realm" : {
                            "type" : "string",
                            "maxLength" : 255,
                            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
                        },
                        "serviceType" : {
                            "description" : "Accounting service type",
                            "enum" : [ "NA", "RADIUS", "CGF" ]
                        }
                    },
                    "required" : [ "realm", "serviceType" ]
                }
            },
            "osu" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "type" : {
                        "description" : "Online singup type",
                        "enum" : [ "Internal", "External" ]
                    },
                    "internalOSU" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "provisioningProtocals" : {
                                "description" : "Provisioning protocal",
                                "type" : "array",
                                "items" : {
                                    "enum" : [ "SOAP_XML", "OMA_DM" ]
                                }
                            },
                            "provisioningFormat" : {
                                "description" : "Provisioning format",
                                "enum" : [ "R1_R2_ZEROIT", "R2_ZEROIT" ]
                            },
                            "provisioningUpdateType" : {
                                "description" : "Provisioning update at",
                                "enum" : [ "ALWAYS", "KNOWN_ROAM_PARTNERS", "NEVER" ]
                            },
                            "osuPortal" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "properties" : {
                                    "type" : {
                                        "description" : "Portal type",
                                        "enum" : [ "Internal", "External" ]
                                    },
                                    "internalOSUPortal" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        },
                                        "description" : "Internal online singup portal, required when type is Internal"
                                    },
                                    "externalUrl" : {
                                        "type" : [ "string", "null" ],
                                        "pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$",
                                        "description" : "External online singup portal, start with https://, required when type is External"
                                    }
                                },
                                "required" : [ "type" ]
                            },
                            "commonLanguageIcon" : {
                                "description" : "The base64 encoded data of icon.",
                                "type" : "string"
                            },
                            "subscriptionDescriptions" : {
                                "description" : "Subscription descriptions",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "language" : {
                                            "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
                                            "description" : "Language of the friendly name"
                                        },
                                        "name" : {
                                            "type" : "string",
                                            "minLength" : 2,
                                            "maxLength" : 32,
                                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                            "description" : "Name of the friendly name"
                                        },
                                        "description" : {
                                            "type" : [ "string", "null" ],
                                            "maxLength" : 64,
                                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                                            "description" : "Description of the friendly name"
                                        },
                                        "icon" : {
                                            "description" : "The binary data of icon, maximum size 65536",
                                            "type" : "string"
                                        }
                                    },
                                    "required" : [ "language", "name" ]
                                }
                            },
                            "certificate" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "id" : {
                                        "type" : "string"
                                    },
                                    "name" : {
                                        "type" : "string"
                                    }
                                },
                                "description" : "Online signup certificate"
                            },
                            "osuAuthServices" : {
                                "description" : "Online signup authentication services",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "id" : {
                                            "description" : "Identifier of authentication service",
                                            "type" : "string"
                                        },
                                        "name" : {
                                            "description" : "Authentication service name",
                                            "type" : "string"
                                        },
                                        "credentialType" : {
                                            "description" : "Authentication credential type",
                                            "enum" : [ "LOCAL", "REMOTE" ]
                                        },
                                        "realm" : {
                                            "type" : "string",
                                            "maxLength" : 255,
                                            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                            "description" : "Authentication realm"
                                        },
                                        "expiration" : {
                                            "description" : "Expiration hour. null mean never expire",
                                            "type" : [ "integer", "null" ],
                                            "minimum" : 1,
                                            "maximum" : 175200
                                        }
                                    },
                                    "required" : [ "credentialType", "realm" ]
                                }
                            },
                            "whitelistedDomains" : {
                                "description" : "whitelisted domains",
                                "type" : "array",
                                "items" : {
                                    "description" : "Compare with FQDN, it could start with '*.'",
                                    "type" : "string",
                                    "pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
                                }
                            }
                        },
                        "required" : [ "provisioningProtocals", "provisioningFormat", "provisioningUpdateType", "osuPortal", "commonLanguageIcon", "subscriptionDescriptions", "certificate", "osuAuthServices" ],
                        "description" : "Internal online singup, required when type is Internal"
                    },
                    "externalOSU" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "provisioningProtocals" : {
                                "description" : "Provisioning protocal",
                                "type" : "array",
                                "item" : {
                                    "enum" : [ "SOAP_XML", "OMA_DM" ]
                                }
                            },
                            "osuServiceUrl" : {
                                "type" : [ "string", "null" ],
                                "pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$",
                                "description" : "External service URL, start with https://"
                            },
                            "osuNaiRealm" : {
                                "description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
                                "type" : "string"
                            },
                            "commonLanguageIcon" : {
                                "description" : "The base64 encoded data of icon.",
                                "type" : "string"
                            },
                            "subscriptionDescriptions" : {
                                "description" : "Subscription descriptions",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "language" : {
                                            "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
                                            "description" : "Language of the friendly name"
                                        },
                                        "name" : {
                                            "type" : "string",
                                            "minLength" : 2,
                                            "maxLength" : 32,
                                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                            "description" : "Name of the friendly name"
                                        },
                                        "description" : {
                                            "type" : [ "string", "null" ],
                                            "maxLength" : 64,
                                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                                            "description" : "Description of the friendly name"
                                        },
                                        "icon" : {
                                            "description" : "The binary data of icon, maximum size 65536",
                                            "type" : "string"
                                        }
                                    },
                                    "required" : [ "language", "name" ]
                                }
                            },
                            "whitelistedDomains" : {
                                "description" : "Whitelisted domains",
                                "type" : "array",
                                "items" : {
                                    "description" : "Compare with FQDN, it could start with '*.'",
                                    "type" : "string",
                                    "pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
                                }
                            }
                        },
                        "required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ],
                        "description" : "External online singup, required when type is External"
                    }
                },
                "required" : [ "type" ],
                "description" : "Online Signup & Provisioning"
            }
        },
        "required" : [ "name", "realms", "authentications" ]
    }
    
    
  • Response  201
  • Body
    {
        "id" : "profileUUID"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Modify Basic 

/v2_1/profiles/hs20/identityproviders/{id}

Use this API command to modify the basic information of a Hotspot 2.0 identity provider.

  • Request
  • Body
    {
        "name" : "test-hs20provider"
    }
    
    
    Schema
    {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the Hotspot 2.0 identity provider profile"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the Hotspot 2.0 identity provider profile"
        }
    }
    
    
  • Response  204

Modify Realms 

/v2_1/profiles/hs20/identityproviders/{id}/realms

Use this API command to modify realms of a Hotspot 2.0 identity provider.

  • Request
  • Body
    [ {
        "name" : "realm1",
        "encoding" : "UTF8",
        "eapMethods" : [ {
            "type" : "NA"
        }, {
            "type" : "NA"
        }, {
            "type" : "NA"
        }, {
            "type" : "MD5",
            "authSettings" : [ {
                "info" : "Expanded",
                "vendorId" : 2,
                "vendorType" : 34
            }, {
                "info" : "Non",
                "type" : "PAP"
            }, {
                "info" : "Credential",
                "type" : "Softoken"
            } ]
        } ]
    } ]
    
    
    Schema
    {
        "description" : "Realms",
        "type" : "array",
        "items" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "name" : {
                    "type" : "string",
                    "minLength" : 2,
                    "maxLength" : 32,
                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                    "description" : "Name of realm"
                },
                "encoding" : {
                    "description" : "Encoding",
                    "enum" : [ "RFC4282", "UTF8" ]
                },
                "eapMethods" : {
                    "description" : "EAP methods",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "type" : {
                                "description" : "EAP method type",
                                "enum" : [ "NA", "MD5", "EAP_TLS", "EAP_Cisco", "EAP_SIM", "EAP_TTLS", "EAP_AKA", "PEAP", "EAP_MSCHAP_V2", "EAP_AKAs", "Reserved" ]
                            },
                            "authSettings" : {
                                "description" : "EAP method auth settings",
                                "type" : [ "array", "null" ],
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "info" : {
                                            "description" : "EAP auth info",
                                            "enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
                                        },
                                        "type" : {
                                            "description" : "EAP auth type",
                                            "type" : "string"
                                        },
                                        "vendorId" : {
                                            "description" : "EAP auth vendor ID",
                                            "type" : [ "integer", "null" ],
                                            "minimum" : 0,
                                            "maximum" : 16777215
                                        },
                                        "vendorType" : {
                                            "description" : "EAP auth vendor type",
                                            "type" : [ "integer", "null" ],
                                            "minimum" : 0,
                                            "maximum" : 4294967295
                                        }
                                    },
                                    "required" : [ "info" ]
                                }
                            }
                        },
                        "required" : [ "type" ]
                    }
                }
            },
            "required" : [ "name", "encoding", "eapMethods" ]
        }
    }
    
    
  • Response  204

Modify PLMNs 

/v2_1/profiles/hs20/identityproviders/{id}/plmns

Use this API command to modify PLMNs of a Hotspot 2.0 identity provider.

  • Request
  • Body
    [ {
        "mcc" : "124",
        "mnc" : "12"
    }, {
        "mcc" : "389",
        "mnc" : "459"
    } ]
    
    
    Schema
    {
        "description" : "PLMNs",
        "type" : "array",
        "items" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mcc" : {
                    "description" : "MCC",
                    "type" : "string",
                    "pattern" : "^[0-9]{3}$"
                },
                "mnc" : {
                    "description" : "MNC",
                    "type" : "string",
                    "pattern" : "^[0-9]{2,3}$"
                }
            },
            "required" : [ "mcc", "mnc" ]
        }
    }
    
    
  • Response  204

Modify Home OIs 

/v2_1/profiles/hs20/identityproviders/{id}/homeOis

Use this API command to modify home OIs of a Hotspot 2.0 identity provider.

  • Request
  • Body
    [ {
        "name" : "abc",
        "oi" : "121212"
    }, {
        "name" : "edf",
        "oi" : "FFFFFFFFFF"
    } ]
    
    
    Schema
    {
        "description" : "Home OIs",
        "type" : "array",
        "items" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "name" : {
                    "description" : "Name of the home OI",
                    "type" : "string",
                    "maxLength" : 255
                },
                "oi" : {
                    "description" : "Orgnization ID(3Hex or 5Hex)",
                    "type" : "string",
                    "pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
                }
            },
            "required" : [ "name", "oi" ]
        }
    }
    
    
  • Response  204

Modify Authentications 

/v2_1/profiles/hs20/identityproviders/{id}/authentications

Use this API command to modify authentications of a Hotspot 2.0 identity provider.

  • Request
  • Body
    [ {
        "name" : "Local Database",
        "realm" : "No Match",
        "serviceType" : "LOCAL_DB"
    }, {
        "name" : "globalAuthRadius",
        "realm" : "Unspecified",
        "serviceType" : "RADIUS"
    }, {
        "name" : "globalAuthRadius",
        "realm" : "realmTest",
        "serviceType" : "RADIUS"
    } ]
    
    
    Schema
    {
        "description" : "Authentications",
        "type" : "array",
        "items" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Authentication id",
                    "type" : [ "string", "null" ]
                },
                "name" : {
                    "description" : "Authentication name",
                    "type" : [ "string", "null" ]
                },
                "realm" : {
                    "type" : "string",
                    "maxLength" : 255,
                    "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                    "description" : "Authentication realm"
                },
                "serviceType" : {
                    "description" : "Authentication service type",
                    "enum" : [ "NA", "LOCAL_DB", "RADIUS" ]
                },
                "vlanId" : {
                    "description" : "Dynamic vlan ID",
                    "type" : [ "integer", "null" ],
                    "minimum" : 1,
                    "maximum" : 4094
                }
            },
            "required" : [ "realm", "serviceType" ]
        }
    }
    
    
  • Response  204

Modify Accountings 

/v2_1/profiles/hs20/identityproviders/{id}/accountings

Use this API command to modify accountings of a Hotspot 2.0 identity provider.

  • Request
  • Body
    [ {
        "realm" : "No Match",
        "serviceType" : "NA"
    }, {
        "name" : "globalAcctRadius",
        "realm" : "Unspecified",
        "serviceType" : "RADIUS"
    }, {
        "name" : "globalAcctRadius",
        "realm" : "realmTest",
        "serviceType" : "RADIUS"
    } ]
    
    
    Schema
    {
        "description" : "Accountings",
        "type" : "array",
        "items" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Accounting id",
                    "type" : [ "string", "null" ]
                },
                "name" : {
                    "description" : "Accounting name",
                    "type" : [ "string", "null" ]
                },
                "realm" : {
                    "type" : "string",
                    "maxLength" : 255,
                    "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
                },
                "serviceType" : {
                    "description" : "Accounting service type",
                    "enum" : [ "NA", "RADIUS", "CGF" ]
                }
            },
            "required" : [ "realm", "serviceType" ]
        }
    }
    
    
  • Response  204

Disable Accountings 

/v2_1/profiles/hs20/identityproviders/{id}/accountings

Use this API command to disable accountings of a Hotspot 2.0 identity provider.

  • Response  204

Modify Online Signup & Provisioning 

/v2_1/profiles/hs20/identityproviders/{id}/osu

Use this API command to modify online signup & provisioning of a Hotspot 2.0 identity provider.

  • Request
  • Body
    {
        "type" : "Internal",
        "internalOSU" : {
            "provisioningProtocals" : [ "SOAP_XML" ],
            "provisioningFormat" : "R1_R2_ZEROIT",
            "provisioningUpdateType" : "ALWAYS",
            "osuPortal" : {
                "type" : "Internal",
                "internalOSUPortal" : {
                    "name" : "${PROFILE_ONLINE_SIGNUP_NAME}"
                }
            },
            "commonLanguageIcon" : "Base64:imageData",
            "serviceDescriptions" : [ {
                "language" : "English",
                "name" : "ruckus"
            } ],
            "certificate" : {
                "id" : "certificateID",
                "name" : "certificateName"
            },
            "whitelistedDomains" : [ "google.com", "*.ruckus.com" ],
            "osuAuthServices" : [ {
                "name" : "Local Database",
                "credentialType" : "LOCAL",
                "realm" : "realm1"
            } ]
        },
        "externalOSU" : {
            "provisioningProtocals" : [ "SOAP_XML", "OMA_DM" ],
            "osuServiceUrl" : "https://ruckus.com",
            "osuNaiRealm" : "realm1",
            "commonLanguageIcon" : "Base64:imageData",
            "serviceDescriptions" : [ {
                "language" : "English",
                "name" : "ruckus"
            } ],
            "whitelistedDomains" : [ "google.com", "*.ruckus.com" ]
        }
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "type" : {
                "description" : "Online singup type",
                "enum" : [ "Internal", "External" ]
            },
            "internalOSU" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "provisioningProtocals" : {
                        "description" : "Provisioning protocal",
                        "type" : "array",
                        "items" : {
                            "enum" : [ "SOAP_XML", "OMA_DM" ]
                        }
                    },
                    "provisioningFormat" : {
                        "description" : "Provisioning format",
                        "enum" : [ "R1_R2_ZEROIT", "R2_ZEROIT" ]
                    },
                    "provisioningUpdateType" : {
                        "description" : "Provisioning update at",
                        "enum" : [ "ALWAYS", "KNOWN_ROAM_PARTNERS", "NEVER" ]
                    },
                    "osuPortal" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "type" : {
                                "description" : "Portal type",
                                "enum" : [ "Internal", "External" ]
                            },
                            "internalOSUPortal" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "id" : {
                                        "type" : "string"
                                    },
                                    "name" : {
                                        "type" : "string"
                                    }
                                },
                                "description" : "Internal online singup portal, required when type is Internal"
                            },
                            "externalUrl" : {
                                "type" : [ "string", "null" ],
                                "pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$",
                                "description" : "External online singup portal, start with https://, required when type is External"
                            }
                        },
                        "required" : [ "type" ]
                    },
                    "commonLanguageIcon" : {
                        "description" : "The base64 encoded data of icon.",
                        "type" : "string"
                    },
                    "subscriptionDescriptions" : {
                        "description" : "Subscription descriptions",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "language" : {
                                    "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
                                    "description" : "Language of the friendly name"
                                },
                                "name" : {
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32,
                                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                    "description" : "Name of the friendly name"
                                },
                                "description" : {
                                    "type" : [ "string", "null" ],
                                    "maxLength" : 64,
                                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                                    "description" : "Description of the friendly name"
                                },
                                "icon" : {
                                    "description" : "The binary data of icon, maximum size 65536",
                                    "type" : "string"
                                }
                            },
                            "required" : [ "language", "name" ]
                        }
                    },
                    "certificate" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        },
                        "description" : "Online signup certificate"
                    },
                    "osuAuthServices" : {
                        "description" : "Online signup authentication services",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "id" : {
                                    "description" : "Identifier of authentication service",
                                    "type" : "string"
                                },
                                "name" : {
                                    "description" : "Authentication service name",
                                    "type" : "string"
                                },
                                "credentialType" : {
                                    "description" : "Authentication credential type",
                                    "enum" : [ "LOCAL", "REMOTE" ]
                                },
                                "realm" : {
                                    "type" : "string",
                                    "maxLength" : 255,
                                    "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                    "description" : "Authentication realm"
                                },
                                "expiration" : {
                                    "description" : "Expiration hour. null mean never expire",
                                    "type" : [ "integer", "null" ],
                                    "minimum" : 1,
                                    "maximum" : 175200
                                }
                            },
                            "required" : [ "credentialType", "realm" ]
                        }
                    },
                    "whitelistedDomains" : {
                        "description" : "whitelisted domains",
                        "type" : "array",
                        "items" : {
                            "description" : "Compare with FQDN, it could start with '*.'",
                            "type" : "string",
                            "pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
                        }
                    }
                },
                "required" : [ "provisioningProtocals", "provisioningFormat", "provisioningUpdateType", "osuPortal", "commonLanguageIcon", "subscriptionDescriptions", "certificate", "osuAuthServices" ],
                "description" : "Internal online singup, required when type is Internal"
            },
            "externalOSU" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "provisioningProtocals" : {
                        "description" : "Provisioning protocal",
                        "type" : "array",
                        "item" : {
                            "enum" : [ "SOAP_XML", "OMA_DM" ]
                        }
                    },
                    "osuServiceUrl" : {
                        "type" : [ "string", "null" ],
                        "pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$",
                        "description" : "External service URL, start with https://"
                    },
                    "osuNaiRealm" : {
                        "description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
                        "type" : "string"
                    },
                    "commonLanguageIcon" : {
                        "description" : "The base64 encoded data of icon.",
                        "type" : "string"
                    },
                    "subscriptionDescriptions" : {
                        "description" : "Subscription descriptions",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "language" : {
                                    "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
                                    "description" : "Language of the friendly name"
                                },
                                "name" : {
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32,
                                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                                    "description" : "Name of the friendly name"
                                },
                                "description" : {
                                    "type" : [ "string", "null" ],
                                    "maxLength" : 64,
                                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                                    "description" : "Description of the friendly name"
                                },
                                "icon" : {
                                    "description" : "The binary data of icon, maximum size 65536",
                                    "type" : "string"
                                }
                            },
                            "required" : [ "language", "name" ]
                        }
                    },
                    "whitelistedDomains" : {
                        "description" : "Whitelisted domains",
                        "type" : "array",
                        "items" : {
                            "description" : "Compare with FQDN, it could start with '*.'",
                            "type" : "string",
                            "pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
                        }
                    }
                },
                "required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ],
                "description" : "External online singup, required when type is External"
            }
        },
        "required" : [ "type" ],
        "description" : "Online Signup & Provisioning"
    }
    
    
  • Response  204

Disable Online Signup & Provisioning 

/v2_1/profiles/hs20/identityproviders/{id}/osu

Use this API command to disable online signup & provisioning of a Hotspot 2.0 identity provider.

  • Response  204

Delete 

/v2_1/profiles/hs20/identityproviders/{id}

Use this API command to delete a Hotspot 2.0 identity provider.

  • Response  204

Certificate 

Retrieve Certificate List 

/v2_1/certstore/certificate

Use this API command to retrieve list of installed certificates.

  • 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" : "rootCertificate",
            "name" : "rootCertificate",
            "description" : "root certificate description"
        }, {
            "id" : "hs20Certificate",
            "name" : "hs20Certificate",
            "description" : "Hotspot20 certificate description"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the certificate",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the certificate"
                        },
                        "description" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 64,
                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                            "description" : "Description of the certificate"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve Certificate 

/v2_1/certstore/certificate/{id}

Use this API command to retrieve an installed certificate.

  • Response  200
  • Body
    {
        "id" : "certificateID",
        "name" : "certificateName",
        "description" : "certificate description",
        "data" : "certificateData",
        "information" : "certificateInformation",
        "intermediateData" : [ "intermediateCertifcateData1", "intermediateCertifcateData2" ],
        "rootData" : "rootCertificateData",
        "privateKeyData" : "privateKeyData",
        "certificasSigningRequest" : null,
        "passphrase" : "passphrase"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the certificate",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the certificate"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the certificate"
            },
            "data" : {
                "description" : "Data of the certificate",
                "type" : "string"
            },
            "information" : {
                "description" : "Information of the certificate",
                "type" : "string"
            },
            "intermediateData" : {
                "description" : "Intermediate data of the certificate",
                "type" : [ "array", "null" ],
                "items" : {
                    "type" : "string"
                }
            },
            "rootData" : {
                "description" : "Root data of the certificate",
                "type" : "string"
            },
            "privateKeyData" : {
                "description" : "Private key data of the certificate",
                "type" : "string"
            },
            "certificasSigningRequest" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Certificates signing request of the certificate"
            },
            "passphrase" : {
                "description" : "Key passphrase",
                "type" : "string"
            }
        }
    }
    
    

Retrieve CSR List 

/v2_1/certstore/csr

Use this API command to retrieve list of certificates signing request.

  • 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" : "privateKey1",
            "name" : "privateKey1",
            "description" : "private key1 description"
        }, {
            "id" : "privateKey2",
            "name" : "privateKey2",
            "description" : "private key2 description"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the certificates signing request",
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string",
                            "minLength" : 2,
                            "maxLength" : 32,
                            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                            "description" : "Name of the certificates signing request"
                        },
                        "description" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 64,
                            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                            "description" : "Description of the certificates signing request"
                        }
                    }
                }
            }
        }
    }
    
    

Retrieve CSR 

/v2_1/certstore/csr/{id}

Use this API command to retrieve a certificates signing request.

  • Response  200
  • Body
    {
        "id" : "csrID",
        "name" : "csr-test",
        "commonName" : "ruckus.com",
        "email" : "[email protected]",
        "organization" : "org",
        "organizationUnit" : "orgUnit",
        "city" : "shenzhen",
        "state" : "guangdong",
        "countryCode" : "US"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "description" : "Identifier of the certificates signing request",
                "type" : "string"
            },
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the certificates signing request"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the certificates signing request"
            },
            "commonName" : {
                "description" : "Common name of the certificates signing request",
                "type" : "string"
            },
            "email" : {
                "description" : "Email of the certificates signing request",
                "type" : "string"
            },
            "organization" : {
                "description" : "Organization of the certificates signing request",
                "type" : "string"
            },
            "organizationUnit" : {
                "description" : "Organization unit of the certificates signing request",
                "type" : "string"
            },
            "city" : {
                "description" : "City of the certificates signing request",
                "type" : "string"
            },
            "state" : {
                "description" : "State of the certificates signing request",
                "type" : "string"
            },
            "countryCode" : {
                "description" : "Country code of the certificates signing request",
                "type" : "string"
            }
        }
    }
    
    

Create Certificate 

/v2_1/certstore/certificate

Use this API command to create an installed certificate.

  • Request
  • Body
    {
        "name" : "hs20Certificate",
        "description" : "Hotspot20 certificate description",
        "data" : "certificateData",
        "intermediateData" : [ "intermediateCertifcateData1", "intermediateCertifcateData2" ],
        "rootData" : "rootCertificateData",
        "privateKeyData" : "privateKeyData",
        "passphrase" : "passphrase"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the certificate"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the certificate"
            },
            "data" : {
                "description" : "Data of the certificate",
                "type" : "string"
            },
            "intermediateData" : {
                "description" : "Intermediate data of the certificate",
                "type" : [ "array", "null" ],
                "items" : {
                    "type" : "string"
                }
            },
            "rootData" : {
                "description" : "Root data of the certificate",
                "type" : "string"
            },
            "privateKeyData" : {
                "description" : "Private key data of the certificate",
                "type" : "string"
            },
            "certificasSigningRequest" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                },
                "description" : "Certificates signing request of the certificate"
            },
            "passphrase" : {
                "description" : "Key passphrase",
                "type" : "string"
            }
        },
        "required" : [ "name", "data" ]
    }
    
    
  • Response  201
  • Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Create CSR 

/v2_1/certstore/csr

Use this API command to create a certificates signing request.

  • Request
  • Body
    {
        "name" : "csr-test",
        "commonName" : "ruckus.com",
        "email" : "[email protected]",
        "organization" : "org",
        "city" : "shenzhen",
        "state" : "guangdong",
        "countryCode" : "US"
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "name" : {
                "type" : "string",
                "minLength" : 2,
                "maxLength" : 32,
                "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                "description" : "Name of the certificates signing request"
            },
            "description" : {
                "type" : [ "string", "null" ],
                "maxLength" : 64,
                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                "description" : "Description of the certificates signing request"
            },
            "commonName" : {
                "type" : "string",
                "pattern" : "^(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}$",
                "description" : "Common name of the certificates signing request"
            },
            "email" : {
                "type" : "string",
                "pattern" : "^(\w+)([\-+.\'][\w]+)*@(\w[\-\w]*\.){1,255}([A-Za-z]){2,6}$",
                "description" : "Email of the certificates signing request"
            },
            "organization" : {
                "description" : "Organization of the certificates signing request",
                "type" : "string",
                "maxLength" : 64
            },
            "organizationUnit" : {
                "description" : "Organization unit of the certificates signing request",
                "type" : "string",
                "maxLength" : 64
            },
            "city" : {
                "description" : "City of the certificates signing request",
                "type" : "string",
                "maxLength" : 128
            },
            "state" : {
                "description" : "State of the certificates signing request",
                "type" : "string",
                "maxLength" : 128
            },
            "countryCode" : {
                "description" : "Country code of the certificates signing request",
                "type" : "string"
            }
        },
        "required" : [ "name", "commonName", "email", "organization", "city", "state", "countryCode" ]
    }
    
    
  • Response  201
  • Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "id" : {
                "type" : "string"
            }
        }
    }
    
    

Delete Certificate 

/v2_1/certstore/certificate/{id}

Use this API command to delete an installed certificate.

  • Response  204

Delete CSR 

/v2_1/certstore/csr/{id}

Use this API command to delete a certificates signing request.

  • Response  204

AP APP 

Retrieve Total AP Count 

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

/v2_1/aps/lineman

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

  • 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 

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

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

/v2_1/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",
                "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",
                "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 

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

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

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

/v2_1/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",
            "apVersion" : "3.0.0.0.125",
            "controlIp" : "172.18.114.29",
            "clusterIp" : "172.18.114.32",
            "managementIp" : "172.18.114.96"
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the controller",
                            "type" : "string"
                        },
                        "model" : {
                            "description" : "Product model",
                            "type" : "string"
                        },
                        "description" : {
                            "description" : "Description of the controller",
                            "type" : "string"
                        },
                        "hostName" : {
                            "description" : "Host name of the controller",
                            "type" : "string"
                        },
                        "mac" : {
                            "description" : "MAC address of the controller",
                            "type" : "string"
                        },
                        "serialNumber" : {
                            "description" : "Serial number of the controller",
                            "type" : "string"
                        },
                        "clusterRole" : {
                            "description" : "Indicator the role of the controller",
                            "type" : "string"
                        },
                        "controlNatIp" : {
                            "description" : "Control NAT IP address settings",
                            "type" : "string"
                        },
                        "uptimeInSec" : {
                            "description" : "Uptime (in seconds) of the controller",
                            "type" : "integer"
                        },
                        "name" : {
                            "description" : "Name of the controller",
                            "type" : "string"
                        },
                        "version" : {
                            "description" : "SCG version",
                            "type" : "string"
                        },
                        "apVersion" : {
                            "description" : "AP version",
                            "type" : "string"
                        },
                        "controlIp" : {
                            "description" : "Control IP",
                            "type" : "string"
                        },
                        "clusterIp" : {
                            "description" : "Cluster IP",
                            "type" : "string"
                        },
                        "managementIp" : {
                            "description" : "Management IP",
                            "type" : "string"
                        },
                        "controlIpv6" : {
                            "description" : "Control IPv6",
                            "type" : "string"
                        },
                        "managementIpv6" : {
                            "description" : "Management IPv6",
                            "type" : "string"
                        }
                    }
                }
            }
        }
    }
    
    

AP Models 

/v2_1/system/apmodels

Use this API command to retrieve AP models.

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

System Statistics 

/v2_1/controller/{id}/statistics

Use this API command to retrieve the system statistics.

  • Parameters
  • interval
    string (optional) 

    Interval, only valid of (QUARTER, HOUR, DAY). Default: QUARTER

    size
    number (optional) 

    Size, list size to response. Default: 32

  • Response  200
  • Body
    [ {
        "cpId" : "f214c803-c88f-40f8-83d5-a6e37a9840de",
        "timestamp" : 1419877800000,
        "cpu" : {
            "percent" : 8.776667,
            "maxPercent" : 32.85,
            "minPercent" : 3.78
        },
        "disk" : {
            "total" : 71417208,
            "free" : 70844653,
            "maxFree" : 70845604,
            "minFree" : 70843696
        },
        "memory" : {
            "percent" : 77.59,
            "maxPercent" : 77.61,
            "minPercent" : 77.58
        },
        "control" : {
            "rxBps" : 898,
            "rxBpsMax" : 9160,
            "rxBpsMin" : 192,
            "rxBytes" : 101038,
            "rxDropped" : 0,
            "rxPackets" : 761,
            "txBps" : 293,
            "txBpsMax" : 4771.2,
            "txBpsMin" : 0,
            "txBytes" : 32964,
            "txDropped" : 0,
            "txPackets" : 209
        },
        "cluster" : {
            "rxBps" : 24,
            "rxBpsMax" : 2080,
            "rxBpsMin" : 0,
            "rxBytes" : 2794,
            "rxDropped" : 0,
            "rxPackets" : 10,
            "txBps" : 6,
            "txBpsMax" : 614.4,
            "txBpsMin" : 0,
            "txBytes" : 768,
            "txDropped" : 0,
            "txPackets" : 4
        },
        "management" : {
            "rxBps" : 216,
            "rxBpsMax" : 25016,
            "rxBpsMin" : 0,
            "rxBytes" : 24328,
            "rxDropped" : 0,
            "rxPackets" : 146,
            "txBps" : 139,
            "txBpsMax" : 15129.6,
            "txBpsMin" : 0,
            "txBytes" : 15641,
            "txDropped" : 0,
            "txPackets" : 108
        },
        "port0" : {
            "rxBps" : 867,
            "rxBpsMax" : 9064,
            "rxBpsMin" : 192,
            "rxBytes" : 97557,
            "rxDropped" : 0,
            "rxPackets" : 732,
            "txBps" : 293,
            "txBpsMax" : 4771.2,
            "txBpsMin" : 0,
            "txBytes" : 32964,
            "txDropped" : 0,
            "txPackets" : 209
        },
        "port1" : {
            "rxBps" : 13,
            "rxBpsMax" : 1040,
            "rxBpsMin" : 0,
            "rxBytes" : 1494,
            "rxDropped" : 0,
            "rxPackets" : 6,
            "txBps" : 6,
            "txBpsMax" : 614.4,
            "txBpsMin" : 0,
            "txBytes" : 768,
            "txDropped" : 0,
            "txPackets" : 4
        },
        "port2" : {
            "rxBps" : 216,
            "rxBpsMax" : 25016,
            "rxBpsMin" : 0,
            "rxBytes" : 24328,
            "rxDropped" : 0,
            "rxPackets" : 146,
            "txBps" : 139,
            "txBpsMax" : 15129.6,
            "txBpsMin" : 0,
            "txBytes" : 15641,
            "txDropped" : 0,
            "txPackets" : 108
        },
        "port3" : {
            "rxBps" : 30,
            "rxBpsMax" : 1248,
            "rxBpsMin" : 0,
            "rxBytes" : 3481,
            "rxDropped" : 0,
            "rxPackets" : 29,
            "txBps" : 0,
            "txBpsMax" : 0,
            "txBpsMin" : 0,
            "txBytes" : 0,
            "txDropped" : 0,
            "txPackets" : 0
        },
        "port4" : {
            "rxBps" : 11,
            "rxBpsMax" : 1040,
            "rxBpsMin" : 0,
            "rxBytes" : 1300,
            "rxDropped" : 0,
            "rxPackets" : 4,
            "txBps" : 0,
            "txBpsMax" : 0,
            "txBpsMin" : 0,
            "txBytes" : 0,
            "txDropped" : 0,
            "txPackets" : 0
        },
        "port5" : {
            "rxBps" : 0,
            "rxBpsMax" : 0,
            "rxBpsMin" : 0,
            "rxBytes" : 0,
            "rxDropped" : 0,
            "rxPackets" : 0,
            "txBps" : 0,
            "txBpsMax" : 0,
            "txBpsMin" : 0,
            "txBytes" : 0,
            "txDropped" : 0,
            "txPackets" : 0
        }
    } ]
    
    

System Inventory 

/v2_1/system/inventory

Use this API command to retrieve the system inventory with current logon user 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

  • Response  200
  • Body
    {
        "totalCount" : 2,
        "hasMore" : false,
        "firstIndex" : 0,
        "list" : [ {
            "zoneId" : "1690614e-1c1f-4fe8-9144-24ccf28d83c4",
            "zoneName" : "api-test-zone",
            "meshSSID" : null,
            "totalAPs" : 0,
            "discoveryAPs" : 0,
            "provisionedAPs" : 0,
            "connectedAPs" : 0,
            "disconnectedAPs" : 0,
            "rebootingAPs" : 0,
            "connectedRootAPs" : 0,
            "disconnectedRootAPs" : 0,
            "rebootingRootAPs" : 0,
            "connectedMeshAPs" : 0,
            "disconnectedMeshAPs" : 0,
            "rebootingMeshAPs" : 0,
            "connectedeMeshAPs" : 0,
            "disconnectedeMeshAPs" : 0,
            "rebootingeMeshAPs" : 0,
            "connectedDownMeshAPs" : 0,
            "disconnectedDownMeshAPs" : 0,
            "rebootingDownMeshAPs" : 0,
            "connectedMeshDisabledAPs" : 0,
            "disconnectedMeshDisabledAPs" : 0,
            "clients" : 0
        }, {
            "zoneId" : "b4187899-38ae-4ace-8e40-0bc444455156",
            "zoneName" : "Staging Zone",
            "meshSSID" : null,
            "totalAPs" : 1,
            "discoveryAPs" : 0,
            "provisionedAPs" : 0,
            "connectedAPs" : 1,
            "disconnectedAPs" : 0,
            "rebootingAPs" : 0,
            "connectedRootAPs" : 0,
            "disconnectedRootAPs" : 0,
            "rebootingRootAPs" : 0,
            "connectedMeshAPs" : 0,
            "disconnectedMeshAPs" : 0,
            "rebootingMeshAPs" : 0,
            "connectedeMeshAPs" : 0,
            "disconnectedeMeshAPs" : 0,
            "rebootingeMeshAPs" : 0,
            "connectedDownMeshAPs" : 0,
            "disconnectedDownMeshAPs" : 0,
            "rebootingDownMeshAPs" : 0,
            "connectedMeshDisabledAPs" : 1,
            "disconnectedMeshDisabledAPs" : 0,
            "clients" : 0
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "type" : "integer"
            },
            "hasMore" : {
                "type" : "boolean"
            },
            "firstIndex" : {
                "type" : "integer"
            },
            "list" : {
                "type" : "array"
            }
        }
    }
    
    

Wireless Client 

Retrieve Total Client Count 

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

/v2_1/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",
            "ipv6Address" : "2001:b030:2516:1a0::5d6e",
            "hostName" : "SDC-Randall-PC",
            "osType" : "Windows 7/Vista",
            "user" : "",
            "status" : "AUTHORIZED",
            "radioId" : "0",
            "radioMode" : null,
            "channel" : "11",
            "wlanId" : "1",
            "ssid" : "client-test",
            "fromClientBytes" : 240863,
            "toClientBytes" : 642897,
            "fromClientPkts" : 2247,
            "toClientPkts" : 7678,
            "connectedSince" : 2600,
            "vlan" : "1",
            "toClientDroppedPkts" : 108
        } ]
    }
    
    
    Schema
    {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
            "totalCount" : {
                "description" : "Total client count",
                "type" : "integer"
            },
            "hasMore" : {
                "description" : "Indicates whether there are more clients after the currently displayed list",
                "type" : "boolean"
            },
            "firstIndex" : {
                "description" : "Index of the first client returned out of the complete client list",
                "type" : "integer"
            },
            "list" : {
                "type" : "array",
                "items" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "mac" : {
                            "type" : "string",
                            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
                            "description" : "MAC of the Client"
                        },
                        "ipAddress" : {
                            "type" : "string",
                            "description" : "IP address of the Client"
                        },
                        "ipv6Address" : {
                            "type" : "string",
                            "description" : "IP V6 address of the Client"
                        },
                        "hostName" : {
                            "description" : "Host name",
                            "type" : "string"
                        },
                        "osType" : {
                            "description" : "OS type",
                            "type" : "string"
                        },
                        "user" : {
                            "description" : "User",
                            "type" : "string"
                        },
                        "status" : {
                            "description" : "Status",
                            "type" : "string"
                        },
                        "radioId" : {
                            "description" : "Radio inditifier",
                            "type" : "string"
                        },
                        "radioMode" : {
                            "description" : "Radio mode",
                            "type" : "string"
                        },
                        "channel" : {
                            "description" : "Channel",
                            "type" : "string"
                        },
                        "wlanId" : {
                            "description" : "WLAN inditifier",
                            "type" : "string"
                        },
                        "ssid" : {
                            "description" : "SSID",
                            "type" : "string"
                        },
                        "rssi" : {
                            "description" : "RSSI",
                            "type" : "string"
                        },
                        "fromClientBytes" : {
                            "description" : "From client bytes",
                            "type" : "integer"
                        },
                        "toClientBytes" : {
                            "description" : "To client bytes",
                            "type" : "integer"
                        },
                        "fromClientPkts" : {
                            "description" : "From client package frames",
                            "type" : "integer"
                        },
                        "toClientPkts" : {
                            "description" : "To client package frames",
                            "type" : "integer"
                        },
                        "connectedSince" : {
                            "description" : "Connected since (in milliseconds)",
                            "type" : "integer"
                        },
                        "vlan" : {
                            "description" : "VLAN id",
                            "type" : "string"
                        },
                        "toClientDroppedPkts" : {
                            "description" : "To client dropped packages",
                            "type" : "integer"
                        }
                    }
                }
            }
        }
    }
    
    

Generated by aglio on 04 Sep 2015